Field Definitions
Tools for custom field definitions and field groups — reading and editing definitions, listing selectable values, and inspecting field population logs.
This page covers 17 tools, 17 of them in the default tool list, and 2 destructive.
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
create_field_definition | Default | Creates a new custom metadata field definition in Aprimo. |
create_field_group | Default | Creates a new Aprimo field group. |
delete_field_definition | Default | Destructive. Permanently deletes an Aprimo custom metadata field definition by id or by name. |
delete_field_group | Default | Destructive. Permanently deletes an Aprimo field group by id or by name. |
get_custom_field_definition | Default | Returns the definition of a custom field in Aprimo, including its data type, validation rules, and available values for option list fields. |
get_field_definition_list_values | Default | Lists the classifications selectable as values on a classification-list Aprimo field definition, by id or by name. |
get_field_group | Default | Gets one Aprimo field group's detail (name, custom tag, dates) by id or by name. |
get_field_group_created_by | Default | Gets the Aprimo user who created a field group, by id or by name. |
get_field_group_modified_by | Default | Gets the Aprimo user who last modified a field group, by id or by name. |
get_field_population_log_recent | Default | Lists recent ai-predicted values for one Aprimo field: the record each prediction was made for, the initial and updated values, and whether the prediction was accepted or overwritten. |
list_field_definitions | Default | Lists the custom metadata field definitions configured in Aprimo: name, label, data type, scope, validation, and dates. |
list_field_group_members | Default | Lists the custom metadata field definitions that are members of an Aprimo field group, by id or by name. |
list_field_groups | Default | Lists the field groups configured in Aprimo — named groupings of custom metadata field definitions, used to organize related fields for display in the DAM UI. |
list_field_population_log_summary | Default | Lists aggregate ai metadata-prediction stats for every Aprimo field that has them: how often a value was predicted versus attempted, and how often the prediction was retained (accepted) rather than overwritten. |
search_field_definitions | Default | Searches custom metadata field definitions in Aprimo with the filter sent in the request body instead of the query string — functionally equivalent to list_field_definitions, but usable when the filter expression is too long for a header/query string. |
update_field_definition | Default | Edits an existing Aprimo custom metadata field definition by id or by name. |
update_field_group | Default | Edits an existing Aprimo field group by id or by name. |
create_field_definition
In the default tool list
Creates a new custom metadata field definition in Aprimo. This modifies data. Always confirm the name, data type, and scope with the user before calling this tool. Covers cross-data-type attributes only — data-type-specific configuration (e.g. option-list items, numeric range) is not supported by this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new field definition, exactly as the user stated it. |
dataType | string | Yes | The field's data type. One of: SingleLineText, MultiLineText, Numeric, DateTime, Date, Time, OptionList, Duration, UserList, UserGroupList, Html, Json, ClassificationList, RecordList, RecordLink, LanguageList, TextList, HyperlinkList. |
scope | string | No | Optional scope. One of: RecordContentGlobal, RecordContentClassDependent, RecordContentFloating, ClassificationProfileClassDependent, UserGlobal, FileFileTypeDependent, FileFloating, IndexerTaskGlobal, FileGlobal, ClassificationProfileFloating, RecordContentContentTypeDependent. |
labels | object (map of string) | No | Multi-language labels for the field's name: a map of languageId (GUID) to label value. |
helpTexts | object (map of string) | No | Multi-language help texts for the field: a map of languageId (GUID) to help-text value. |
isRequired | boolean | No | Whether the field is required. Defaults to false. |
isReadOnly | boolean | No | Whether the field is read-only. Defaults to false. |
isUniqueIdentifier | boolean | No | Whether the field's value must be unique across records. Defaults to false. |
indexed | boolean | No | Whether searching on this field is enabled. Defaults to false. |
inlineStyle | string | No | Optional inline css style applied to the field in the DAM UI. |
sortIndex | integer | No | Optional sort index used to order the field relative to other fields. |
tag | string | No | Optional custom XML tag associated with the field. |
languageMode | string | No | Optional language mode. One of: Single, Multiple. |
defaultValue | string | No | Optional default value assigned to the field. |
resetToDefaultTriggers | array of string | No | Optional triggers that reset the field to its default value. Each one of: None, OnNewField, OnLoad, OnSave, OnAnyFileChange, OnReclassifyRecord, OnAnyChange, OnFieldChange, OnMasterFileChange, OnCurrentFileChange, OnFieldDefinitionChanged, OnDuplicateRecord, OnRecordStatusChange. |
resetToDefaultFieldIds | array of string | No | Field ids (GUIDs) that trigger this field to be reset to its default value — only used when resetToDefaultTriggers includes "OnFieldChange". |
validationTrigger | string | No | Optional validation trigger. One of: None, WhenNeeded, Always. |
validation | string | No | Optional validation expression applied to the field's value. |
validationErrorMessage | string | No | Optional error message shown when validation fails. |
storageMode | string | No | Optional storage mode. One of: None, NonEmptyValues, AllValues, LogChanges. |
enabledLanguageIds | array of string | No | Language ids (GUIDs) in which this field is enabled. |
membershipFieldGroupIds | array of string | No | Field group ids (GUIDs) this field should be a member of. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
create_field_group
In the default tool list
Creates a new Aprimo field group. This modifies data. Always confirm the name and member field definitions with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new field group, exactly as the user stated it. |
tag | string | No | Optional custom XML tag associated with the group. |
memberFieldIds | array of string | No | Field definition ids (GUIDs) to add as members of the new group. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
delete_field_definition
In the default tool list · Destructive
Permanently deletes an Aprimo custom metadata field definition by id or by name. This cannot be undone and removes the field's values from every record that had one. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact field with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldDefinitionId | string | No | The field definition id (GUID) to delete. Provide this or name, not both. |
name | string | No | The field definition's name (case-insensitive, exact match). Provide this or fieldDefinitionId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact field. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a field definition is permanent and cannot be undone. Set only after stating the exact field to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
delete_field_group
In the default tool list · Destructive
Permanently deletes an Aprimo field group by id or by name. This cannot be undone — member field definitions themselves are not deleted, only the grouping. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact group with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID) to delete. Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact group. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a field group is permanent and cannot be undone. Set only after stating the exact group to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_custom_field_definition
In the default tool list
Returns the definition of a custom field in Aprimo, including its data type, validation rules, and available values for option list fields. Use this before update_record_metadata_field to understand a field's type and constraints. The field definition ID is a GUID — get it from the field's 'id' property in get_record_metadata results. For option list fields, the response includes the list of valid option values (name/label pairs).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldDefinitionId | string | Yes | The field definition ID (GUID format). Get from get_record_metadata results: each field in the 'fields' array has an 'id' property. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
label | string (optional) | |
dataType | string (optional) | |
isRequired | boolean | |
isReadOnly | boolean | |
acceptMultipleOptions | boolean (optional) | |
helpText | string (optional) | |
items | array of FieldOptionItem (optional) | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) |
get_field_definition_list_values
In the default tool list
Lists the classifications selectable as values on a classification-list Aprimo field definition, by id or by name. Only meaningful for fields whose dataType is ClassificationList.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldDefinitionId | string | No | The field definition id (GUID). Provide this or name, not both. |
name | string | No | The field definition's name (case-insensitive, exact match). Provide this or fieldDefinitionId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
fieldDefinitionId | string | |
count | integer | |
items | array of ClassificationListFieldItemPayload | |
items[].id | string | |
items[].identifier | string (optional) | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].namePath | string (optional) | |
items[].labelPath | string (optional) | |
items[].parentId | string (optional) | |
items[].disabledInDamUi | boolean (optional) | |
items[].hasChildren | boolean (optional) |
get_field_group
In the default tool list
Gets one Aprimo field group's detail (name, custom tag, dates) by id or by name. Use after list_field_groups, or pass name directly when the user names the group. Not its creator (get_field_group_created_by) or last modifier (get_field_group_modified_by).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID), from list_field_groups. Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
tag | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_field_group_created_by
In the default tool list
Gets the Aprimo user who created a field group, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID). Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
firstName | string (optional) | |
lastName | string (optional) | |
email | string (optional) | |
isActive | boolean (optional) |
get_field_group_modified_by
In the default tool list
Gets the Aprimo user who last modified a field group, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID). Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
firstName | string (optional) | |
lastName | string (optional) | |
email | string (optional) | |
isActive | boolean (optional) |
get_field_population_log_recent
In the default tool list
Lists recent ai-predicted values for one Aprimo field: the record each prediction was made for, the initial and updated values, and whether the prediction was accepted or overwritten.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldId | string | Yes | The field definition id (GUID) to fetch recent predictions for, from list_field_definitions. |
Returns:
| Field | Type | Description |
|---|---|---|
fieldId | string | |
count | integer | |
items | array of FieldPopulationLogPredictionPayload | |
items[].contentItemId | string (optional) | |
items[].contentItemTitle | string (optional) | |
items[].contentItemPreviewImage | string (optional) | |
items[].logDate | string (optional) | |
items[].initialValue | string (optional) | |
items[].lastChangeDate | string (optional) | |
items[].status | string (optional) | |
items[].updatedValue | string (optional) |
list_field_definitions
In the default tool list
Lists the custom metadata field definitions configured in Aprimo: name, label, data type, scope, validation, and dates. Use when the user asks what fields exist, or to look up a field's id/exact name before calling update_field_definition or delete_field_definition by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every field definition. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FieldDefinitionPayload | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].scope | string (optional) | |
items[].scopeCategory | string (optional) | |
items[].indexed | boolean (optional) | |
items[].languageMode | string (optional) | |
items[].isRequired | boolean | |
items[].isReadOnly | boolean | |
items[].isUniqueIdentifier | boolean (optional) | |
items[].inlineStyle | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].tag | string (optional) | |
items[].defaultValue | string (optional) | |
items[].resetToDefaultTriggers | array of string | |
items[].resetToDefaultFieldIds | array of string | |
items[].validation | string (optional) | |
items[].validationErrorMessage | string (optional) | |
items[].validationTrigger | string (optional) | |
items[].storageMode | string (optional) | |
items[].helpText | string (optional) | |
items[].helpTexts | array of FieldDefinitionLabelPayload | |
items[].helpTexts[].value | string (optional) | |
items[].helpTexts[].languageId | string | |
items[].labels | array of FieldDefinitionLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].enabledLanguageIds | array of string | |
items[].membershipFieldGroupIds | array of string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_field_group_members
In the default tool list
Lists the custom metadata field definitions that are members of an Aprimo field group, by id or by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID). Provide this or name, not both. |
name | string | No | The field group's name (case-insensitive, exact match). Provide this or fieldGroupId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
fieldGroupId | string | |
count | integer | |
items | array of FieldDefinitionPayload | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].scope | string (optional) | |
items[].scopeCategory | string (optional) | |
items[].indexed | boolean (optional) | |
items[].languageMode | string (optional) | |
items[].isRequired | boolean | |
items[].isReadOnly | boolean | |
items[].isUniqueIdentifier | boolean (optional) | |
items[].inlineStyle | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].tag | string (optional) | |
items[].defaultValue | string (optional) | |
items[].resetToDefaultTriggers | array of string | |
items[].resetToDefaultFieldIds | array of string | |
items[].validation | string (optional) | |
items[].validationErrorMessage | string (optional) | |
items[].validationTrigger | string (optional) | |
items[].storageMode | string (optional) | |
items[].helpText | string (optional) | |
items[].helpTexts | array of FieldDefinitionLabelPayload | |
items[].helpTexts[].value | string (optional) | |
items[].helpTexts[].languageId | string | |
items[].labels | array of FieldDefinitionLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].enabledLanguageIds | array of string | |
items[].membershipFieldGroupIds | array of string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_field_groups
In the default tool list
Lists the field groups configured in Aprimo — named groupings of custom metadata field definitions, used to organize related fields for display in the DAM UI. Use when the user asks what field groups exist, or to look up a group's id/exact name before calling get_field_group, update_field_group, or delete_field_group by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every field group. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FieldGroupPayload | |
items[].id | string | |
items[].name | string | |
items[].tag | string (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_field_population_log_summary
In the default tool list
Lists aggregate ai metadata-prediction stats for every Aprimo field that has them: how often a value was predicted versus attempted, and how often the prediction was retained (accepted) rather than overwritten. Use to gauge how well ai field prediction is working across fields.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FieldPopulationLogSummaryPayload | |
items[].fieldId | string | |
items[].fieldName | string (optional) | |
items[].hints | string (optional) | |
items[].predictedPercent | number (optional) | |
items[].predictedCount | integer (optional) | |
items[].attemptedCount | integer (optional) | |
items[].retainedPercent | number (optional) | |
items[].retainedCount | integer (optional) |
search_field_definitions
In the default tool list
Searches custom metadata field definitions in Aprimo with the filter sent in the request body instead of the query string — functionally equivalent to list_field_definitions, but usable when the filter expression is too long for a header/query string. This is a read: it never modifies data.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ScopeCategory=Record Indexed=true". Omit to match every field definition. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
checkEditPermission | boolean | No | When true, only field definitions the current user is allowed to edit are returned. Defaults to false. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of FieldDefinitionPayload | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].dataType | string (optional) | |
items[].scope | string (optional) | |
items[].scopeCategory | string (optional) | |
items[].indexed | boolean (optional) | |
items[].languageMode | string (optional) | |
items[].isRequired | boolean | |
items[].isReadOnly | boolean | |
items[].isUniqueIdentifier | boolean (optional) | |
items[].inlineStyle | string (optional) | |
items[].sortIndex | integer (optional) | |
items[].tag | string (optional) | |
items[].defaultValue | string (optional) | |
items[].resetToDefaultTriggers | array of string | |
items[].resetToDefaultFieldIds | array of string | |
items[].validation | string (optional) | |
items[].validationErrorMessage | string (optional) | |
items[].validationTrigger | string (optional) | |
items[].storageMode | string (optional) | |
items[].helpText | string (optional) | |
items[].helpTexts | array of FieldDefinitionLabelPayload | |
items[].helpTexts[].value | string (optional) | |
items[].helpTexts[].languageId | string | |
items[].labels | array of FieldDefinitionLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string | |
items[].enabledLanguageIds | array of string | |
items[].membershipFieldGroupIds | array of string | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
update_field_definition
In the default tool list
Edits an existing Aprimo custom metadata field definition by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact field and the new values with the user before calling this tool. The field's data type cannot be changed after creation.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldDefinitionId | string | No | The field definition id (GUID) to edit. Provide this or name, not both. |
name | string | No | The field definition's current name (case-insensitive, exact match), used to look it up. Provide this or fieldDefinitionId, not both. |
newName | string | No | New name for the field definition. Omit to leave the name unchanged. |
scope | string | No | New scope. One of: RecordContentGlobal, RecordContentClassDependent, RecordContentFloating, ClassificationProfileClassDependent, UserGlobal, FileFileTypeDependent, FileFloating, IndexerTaskGlobal, FileGlobal, ClassificationProfileFloating, RecordContentContentTypeDependent. Omit to leave it unchanged. |
labels | object (map of string) | No | Label values to set: a map of languageId (GUID) to label value. Only the languages provided are changed. |
helpTexts | object (map of string) | No | Help-text values to set: a map of languageId (GUID) to help-text value. Only the languages provided are changed. |
isRequired | boolean | No | New required setting. Omit to leave it unchanged. |
isReadOnly | boolean | No | New read-only setting. Omit to leave it unchanged. |
isUniqueIdentifier | boolean | No | New unique-identifier setting. Omit to leave it unchanged. |
indexed | boolean | No | New indexed setting. Omit to leave it unchanged. |
inlineStyle | string | No | New inline css style. Omit to leave it unchanged. |
sortIndex | integer | No | New sort index. Omit to leave it unchanged. |
tag | string | No | New custom XML tag. Omit to leave it unchanged. |
defaultValue | string | No | New default value. Omit to leave it unchanged. |
resetToDefaultTriggers | array of string | No | New reset-to-default triggers (full replacement list). Each one of: None, OnNewField, OnLoad, OnSave, OnAnyFileChange, OnReclassifyRecord, OnAnyChange, OnFieldChange, OnMasterFileChange, OnCurrentFileChange, OnFieldDefinitionChanged, OnDuplicateRecord, OnRecordStatusChange. Omit to leave it unchanged. |
resetToDefaultFieldIds | array of string | No | New reset-to-default field ids (GUIDs, full replacement list). Omit to leave it unchanged. |
validationTrigger | string | No | New validation trigger. One of: None, WhenNeeded, Always. Omit to leave it unchanged. |
validation | string | No | New validation expression. Omit to leave it unchanged. |
validationErrorMessage | string | No | New validation error message. Omit to leave it unchanged. |
storageMode | string | No | New storage mode. One of: None, NonEmptyValues, AllValues, LogChanges. Omit to leave it unchanged. |
enabledLanguageIdsToAdd | array of string | No | Language ids (GUIDs) to enable this field for. |
enabledLanguageIdsToRemove | array of string | No | Language ids (GUIDs) to disable this field for. |
membershipFieldGroupIdsToAdd | array of string | No | Field group ids (GUIDs) to add this field to. |
membershipFieldGroupIdsToRemove | array of string | No | Field group ids (GUIDs) to remove this field from. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
update_field_group
In the default tool list
Edits an existing Aprimo field group by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact group and the new values with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldGroupId | string | No | The field group id (GUID) to edit. Provide this or name, not both. |
name | string | No | The field group's current name (case-insensitive, exact match), used to look it up. Provide this or fieldGroupId, not both. |
newName | string | No | New name for the field group. Omit to leave the name unchanged. |
tag | string | No | New custom XML tag. Omit to leave the tag unchanged. |
memberFieldIdsToAdd | array of string | No | Field definition ids (GUIDs) to add as members. |
memberFieldIdsToRemove | array of string | No | Field definition ids (GUIDs) to remove from the group. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent