Contribute & change content
Create and change DAM content: upload, edit metadata, check files out and in, annotate, organize into collections, subscribe, and delete records.
This area has 7 groups and 51 tools, 44 of them currently available.
- Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
- Needs. Enabling a group also enables every group it needs. Each group below lists them.
- Read-only groups are intended for look-up access without the ability to change data.
- Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. 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. - Not currently available tools are registered but are not offered in any tool list at this time.
- Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Groups in this area
| Group | Access | Needs | Tools |
|---|---|---|---|
| Upload & Create Content | Can change data | Find & Discover Content, Read the Content Model | 9 |
| Edit Asset Metadata | Can change data | Find & Discover Content, View Asset Metadata & History, Read the Content Model | 10 |
| Check Out, Check In & Lock | Can change data | Find & Discover Content, View Files & Versions, Upload & Create Content | 11 |
| Delete Records | Can change data | Find & Discover Content | 1 |
| Annotate & Comment on Content | Can change data | View Files & Versions | 3 |
| Organize Content into Collections | Can change data | Find & Discover Content, Look Up DAM Users & Groups | 12 |
| Manage Content Subscriptions | Can change data | Find & Discover Content, Look Up DAM Users & Groups | 5 |
Upload & Create Content
Can change data · 9 tools (7 currently available) · Group ID upload-create-content
Needs: Find & Discover Content, Read the Content Model
| Tool | What it does |
|---|---|
add_file_version_to_record | Not currently available. Uploads a file and adds it as a new file version on an existing Aprimo asset (record), in one call. |
apply_and_save_record_edit | Applies changes to an Aprimo record edit session and saves (commits) them -- by default this closes the session; set keep_edit_open=true to keep it open for further apply calls instead. |
apply_record_edit | Applies a partial update to an Aprimo record edit session without closing it -- the session stays open for further apply_record_edit/apply_and_save_record_edit calls, so use this to build up changes across multiple calls before finally committing with apply_and_save_record_edit. |
cancel_record_edit_session | Cancels/discards an Aprimo record edit session, releasing any lock it holds, without saving any changes made during it. |
create_record_draft | Step 1 of the Aprimo record edit-session workflow for a new record, optionally copied from an existing record used as a template (copy_from). |
create_record_with_file | Uploads a file and creates a brand new Aprimo asset (record) referencing it, in one call. |
get_record_edit_session | Reads the current state of an Aprimo record edit session: whether it has outstanding validation errors and a deep link to the record it's editing. |
start_record_edit_session | Not currently available. Step 1 of the Aprimo record edit-session workflow: starts a session for a brand-new, blank record -- DAM's schema for this endpoint carries no record id anywhere, so this can only start a session for a record that doesn't exist yet (use create_record_draft instead to start one copied from an existing record/template, or update_record_metadata_field/apply_record_bulk_edit to edit an already-existing record). |
upload_file | Uploads file bytes to Aprimo's upload storage and returns an upload token. |
add_file_version_to_record
Not currently available
Uploads a file and adds it as a new file version on an existing Aprimo asset (record), in one call. This modifies data -- it adds a new file version to an existing asset. Always confirm with the user before calling this tool. Provide exactly one of fileBase64 (small files, inline) or fileUrl (fetched server-side); filename is required.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex) of the existing asset to add a new file version to. |
fileBase64 | string | No | Base64-encoded file bytes. Mutually exclusive with fileUrl. Requires filename. |
fileUrl | string | No | An http(s) URL to fetch the file bytes from. Mutually exclusive with fileBase64. |
filename | string | No | The file name for the uploaded file. Required when using fileBase64; optional for fileUrl (derived from the URL path if omitted). |
confirmed | boolean | No | Must be true to proceed. Confirm with the user before adding this new file version, then call again with confirmed=true. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
versionAdded | boolean | |
record | RecordPayload (optional) | |
record.id | string | |
record.title | string | |
record.status | string | |
record.contentType | string | |
record.createdOn | string | |
record.modifiedOn | string | |
record.deepLink | string | |
record.fields | map of string | |
note | string (optional) |
apply_and_save_record_edit
Applies changes to an Aprimo record edit session and saves (commits) them -- by default this closes the session; set keep_edit_open=true to keep it open for further apply calls instead. Pass the edit_token from start_record_edit_session/create_record_draft. This modifies data -- confirm with the user before calling. If the response reports validation errors, review them -- fix the change and call again, or cancel_record_edit_session to discard the session. disable_validations=true is high-risk -- confirm it explicitly with the user before calling.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
editToken | string | Yes | The edit token returned when the session was started. |
status | string | No | Optional: lifecycle status to set on the record. |
contentType | string | No | Optional: content type to set on the record. |
tag | string | No | Optional: a tag to distinguish or categorize the record. |
fieldsAddOrUpdate | object (map of string) | No | Field values to add or update. JSON object mapping field name to its new string value. |
fieldsRemove | array of string | No | Field names whose value should be cleared. |
keepEditOpen | boolean | No | Optional: when true, keeps the edit session open after committing instead of closing it, allowing further apply_record_edit/apply_and_save_record_edit calls with the same edit_token. |
disableValidations | boolean | No | High-risk: when true, skips DAM's field and business rule validations for this commit. |
immediateSearchIndexUpdate | boolean | No | Optional: when true, updates the search index immediately instead of waiting for the next scheduled update. |
Returns:
| Field | Type | Description |
|---|---|---|
editToken | string | |
recordLink | string (optional) | /// Deep link to the record this session is editing (Tenant.DamUiBaseUri/contentitems/{id}), resolved from the record id embedded in DAM's _links.record.href -- null if DAM omitted that link; falls back to the raw href if a record id can't be parsed out of it (see RecordEditSessionTools.ExtractRecordIdFromHref). |
hasValidationErrors | boolean | |
validationErrors | array of string |
apply_record_edit
Applies a partial update to an Aprimo record edit session without closing it -- the session stays open for further apply_record_edit/apply_and_save_record_edit calls, so use this to build up changes across multiple calls before finally committing with apply_and_save_record_edit. Pass the edit_token from start_record_edit_session/create_record_draft. This modifies data (uncommitted, held in the session) -- confirm with the user before calling. disable_validations=true is high-risk -- confirm it explicitly with the user before calling.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
editToken | string | Yes | The edit token returned when the session was started. |
status | string | No | Optional: lifecycle status to set on the record. |
contentType | string | No | Optional: content type to set on the record. |
tag | string | No | Optional: a tag to distinguish or categorize the record. |
fieldsAddOrUpdate | object (map of string) | No | Field values to add or update. JSON object mapping field name to its new string value. |
fieldsRemove | array of string | No | Field names whose value should be cleared. |
disableValidations | boolean | No | High-risk: when true, skips DAM's field and business rule validations for this partial update. |
immediateSearchIndexUpdate | boolean | No | Optional: when true, updates the search index immediately instead of waiting for the next scheduled update. |
Returns:
| Field | Type | Description |
|---|---|---|
editToken | string | |
recordLink | string (optional) | /// Deep link to the record this session is editing (Tenant.DamUiBaseUri/contentitems/{id}), resolved from the record id embedded in DAM's _links.record.href -- null if DAM omitted that link; falls back to the raw href if a record id can't be parsed out of it (see RecordEditSessionTools.ExtractRecordIdFromHref). |
hasValidationErrors | boolean | |
validationErrors | array of string |
cancel_record_edit_session
Cancels/discards an Aprimo record edit session, releasing any lock it holds, without saving any changes made during it. Use to clean up a session you decided not to continue. Low-consequence -- an uncommitted draft/edit is simply discarded and can be re-started with start_record_edit_session/create_record_draft. Confirm-gated: call again with confirmed=true after telling the user which session will be discarded.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
editToken | string | Yes | The edit token of the session to discard. |
confirmed | boolean | No | Must be true to proceed. Confirm with the user which session to discard, then call again with confirmed=true. |
Returns:
| Field | Type | Description |
|---|---|---|
editToken | string | |
cancelled | boolean |
create_record_draft
Step 1 of the Aprimo record edit-session workflow for a new record, optionally copied from an existing record used as a template (copy_from). Without copy_from this behaves like start_record_edit_session (a blank new-record draft); With copy_from, DAM copies that record's field values/settings/files into the new draft -- set make_file_names_unique=true to avoid file-name collisions with the source, and copy_relationship_field to link the new record back to the source via a OneParentManyChildren record-link field. Returns an edit_token -- thread it through get_record_edit_session/apply_record_edit/apply_and_save_record_edit/cancel_record_edit_session same as start_record_edit_session. This modifies data -- confirm with the user before calling. disable_validations=true is high-risk -- confirm it explicitly with the user before calling.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
copyFrom | string | No | Optional: the id of an existing record to copy field values/settings/files from. |
makeFileNamesUnique | boolean | No | Optional: when true, makes copied file names unique (e.g. "Copy 1") instead of colliding with copy_from's file names. Only applies when copy_from is set. |
copyRelationshipField | string | No | Optional: the name of a record-link field to relate the new draft back to copy_from (OneParentManyChildren -- copy_from becomes the parent). Only applies when copy_from is set. |
status | string | No | Optional: lifecycle status to set on the new record. |
contentType | string | No | Optional: content type to set on the new record. |
tag | string | No | Optional: a tag to distinguish or categorize the new record. |
fieldsAddOrUpdate | object (map of string) | No | Field values to set on the new record (overrides any value copied from copy_from). JSON object mapping field name to its new string value. |
fieldsRemove | array of string | No | Field names to explicitly clear. |
disableValidations | boolean | No | High-risk: when true, skips DAM's field and business rule validations for this session. |
immediateSearchIndexUpdate | boolean | No | Optional: when true, updates the search index immediately once this session is later committed, instead of waiting for the next scheduled update. |
Returns:
| Field | Type | Description |
|---|---|---|
editToken | string | |
recordLink | string (optional) | /// Deep link to the record this session is editing (Tenant.DamUiBaseUri/contentitems/{id}), resolved from the record id embedded in DAM's _links.record.href -- null if DAM omitted that link; falls back to the raw href if a record id can't be parsed out of it (see RecordEditSessionTools.ExtractRecordIdFromHref). |
hasValidationErrors | boolean | |
validationErrors | array of string |
create_record_with_file
Uploads a file and creates a brand new Aprimo asset (record) referencing it, in one call. This modifies data -- it creates a new asset. Always confirm with the user before calling this tool. Provide exactly one of fileBase64 (small files, inline) or fileUrl (fetched server-side); filename is required. Provide fields as a JSON object of fieldName to new value, e.g. {"Title": "New asset"}, matching update_record_metadata_field's field-input shape. Many tenants require at least one classification before a record can be saved -- pass classificationIds (use browse_classifications or get_classification_by_name_path to resolve names/paths to ids first) or the save will fail with "Record cannot be saved because it is not classified."
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fields | object (map of string) | Yes | JSON object mapping field names to their initial string values for the new record. |
fileBase64 | string | No | Base64-encoded file bytes. Mutually exclusive with fileUrl. Requires filename. |
fileUrl | string | No | An http(s) URL to fetch the file bytes from. Mutually exclusive with fileBase64. |
filename | string | No | The file name for the uploaded file. Required when using fileBase64; optional for fileUrl (derived from the URL path if omitted). |
confirmed | boolean | No | Must be true to proceed. Confirm with the user before creating this new asset, then call again with confirmed=true. |
classificationIds | array of string | No | Classification ids (GUIDs) to assign to the new record. Resolve names/paths to ids first via browse_classifications or get_classification_by_name_path. Omit for none, but note many tenants require at least one classification for the record to save successfully. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string |
get_record_edit_session
Reads the current state of an Aprimo record edit session: whether it has outstanding validation errors and a deep link to the record it's editing. Use to check a session started by start_record_edit_session/create_record_draft before deciding whether to save or cancel it.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
editToken | string | Yes | The edit token returned when the session was started (start_record_edit_session/create_record_draft). |
Returns:
| Field | Type | Description |
|---|---|---|
editToken | string | |
recordLink | string (optional) | /// Deep link to the record this session is editing (Tenant.DamUiBaseUri/contentitems/{id}), resolved from the record id embedded in DAM's _links.record.href -- null if DAM omitted that link; falls back to the raw href if a record id can't be parsed out of it (see RecordEditSessionTools.ExtractRecordIdFromHref). |
hasValidationErrors | boolean | |
validationErrors | array of string |
start_record_edit_session
Not currently available
Step 1 of the Aprimo record edit-session workflow: starts a session for a brand-new, blank record -- DAM's schema for this endpoint carries no record id anywhere, so this can only start a session for a record that doesn't exist yet (use create_record_draft instead to start one copied from an existing record/template, or update_record_metadata_field/apply_record_bulk_edit to edit an already-existing record). Returns an edit_token -- thread it through get_record_edit_session (inspect), apply_record_edit (PATCH, partial update, keeps the session open), apply_and_save_record_edit (POST, applies changes and commits/saves -- closes the session unless keep_edit_open=true), or cancel_record_edit_session (discard). This modifies data (opens a session) -- confirm with the user before calling. disable_validations=true is high-risk -- confirm it explicitly with the user before calling.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Optional: lifecycle status to set on the new record. |
contentType | string | No | Optional: content type to set on the new record. |
tag | string | No | Optional: a tag to distinguish or categorize the new record. |
fieldsAddOrUpdate | object (map of string) | No | Field values to set on the new record. JSON object mapping field name to its new string value. |
fieldsRemove | array of string | No | Field names to explicitly clear (rarely needed on a brand-new record). |
disableValidations | boolean | No | High-risk: when true, skips DAM's field and business rule validations for this session. |
immediateSearchIndexUpdate | boolean | No | Optional: when true, updates the search index immediately once this session is later committed, instead of waiting for the next scheduled update. |
Returns:
| Field | Type | Description |
|---|---|---|
editToken | string | |
recordLink | string (optional) | /// Deep link to the record this session is editing (Tenant.DamUiBaseUri/contentitems/{id}), resolved from the record id embedded in DAM's _links.record.href -- null if DAM omitted that link; falls back to the raw href if a record id can't be parsed out of it (see RecordEditSessionTools.ExtractRecordIdFromHref). |
hasValidationErrors | boolean | |
validationErrors | array of string |
upload_file
Uploads file bytes to Aprimo's upload storage and returns an upload token. This does not create an asset or a new file version by itself -- pass the returned token as the file id to create_record_with_file or add_file_version_to_record to actually attach it. Provide exactly one of fileBase64 (small files, inline) or fileUrl (fetched server-side); filename is required with fileBase64 and optional with fileUrl (derived from the URL path when omitted).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileBase64 | string | No | Base64-encoded file bytes. Mutually exclusive with fileUrl. Requires filename. |
fileUrl | string | No | An http(s) URL to fetch the file bytes from. Mutually exclusive with fileBase64. |
filename | string | No | The file name. Required when using fileBase64; optional for fileUrl (derived from the URL path if omitted). |
Returns:
| Field | Type | Description |
|---|---|---|
token | string | |
filename | string |
Edit Asset Metadata
Can change data · 10 tools (7 currently available) · Group ID edit-asset-metadata
Needs: Find & Discover Content, View Asset Metadata & History, Read the Content Model
| Tool | What it does |
|---|---|
apply_record_bulk_edit | Not currently available. Applies a bulk edit across multiple Aprimo records that was already previewed via preview_record_bulk_edit. |
cancel_record_bulk_edit | Not currently available. Cancels one or more open Aprimo bulk-edit sessions, releasing the record locks those sessions hold, without persisting any changes made during them. |
get_record_bulk_edit_field_list_values | Lists the selectable values for a list-type custom field across one or more open Aprimo bulk-edit sessions (option-list entries, classifications, users, or user groups, depending on the field's dataType) -- the bulk-edit companion to get_record_field_list_values. |
get_record_field_list_values | Lists the selectable values for a list-type custom field on an Aprimo record (option-list entries, classifications, users, or user groups, depending on the field's dataType) — not the field's current value(s); use get_record_field for that. |
preview_record_bulk_edit | Not currently available. Previews a bulk edit (status, content type, and/or field changes) across multiple Aprimo records in one call. |
sanitize_record_field_html | Sanitizes HTML content for an Aprimo record field, stripping disallowed tags/attributes/styles per the field's configured allow-list. |
update_file_preview_rotation | Sets the rotation angle (in degrees) of a file preview on an Aprimo asset by its id. |
update_record_metadata_field | Updates a single metadata field on an Aprimo record. |
update_record_metadata_fields | Updates multiple metadata fields on an Aprimo record in a single call. |
validate_record_field_html | Validates HTML content for an Aprimo record field against the field's allow-list, without modifying anything. |
apply_record_bulk_edit
Not currently available
Applies a bulk edit across multiple Aprimo records that was already previewed via preview_record_bulk_edit. Must be called with the exact same arguments used in that preview call (including the exact same record_ids), plus its confirm_token -- any difference invalidates the token and this is refused. This modifies data. Edits over 1000 records are refused unless acknowledge_large=true is also set. Internally starts a DAM edit session for every targeted record, then commits it -- if this fails partway, call cancel_record_bulk_edit with the returned session token to release any locks left behind. Do not call without having shown the user the preview's diff (especially any high-risk disable_validations warning) and gotten explicit confirmation, then call again with confirmed=true.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordIds | array of string | Yes | Must match the record ids passed to preview_record_bulk_edit. |
status | string | Yes | Must match the value passed to preview_record_bulk_edit. |
contentType | string | Yes | Must match the value passed to preview_record_bulk_edit. |
fieldsAddOrUpdate | object (map of string) | Yes | Must match the value passed to preview_record_bulk_edit. |
fieldsRemove | array of string | Yes | Must match the value passed to preview_record_bulk_edit. |
disableValidations | boolean | Yes | Must match the value passed to preview_record_bulk_edit. |
immediateSearchIndexUpdate | boolean | Yes | Optional: when true, updates the search index immediately instead of waiting for the next scheduled update. |
acknowledgeLarge | boolean | Yes | Must be true when record_ids.Length exceeds 1000 -- an explicit acknowledgement that this many records will be edited at once. |
confirmToken | string | Yes | The confirm_token returned by preview_record_bulk_edit for this exact change. |
confirmed | boolean | Yes | Must be true to apply. Call preview_record_bulk_edit first, review the diff (especially any high-risk disable_validations warning) with the user, then call again with confirmed=true. |
server | McpServer | Yes |
Returns:
| Field | Type | Description |
|---|---|---|
applied | boolean | |
affectedCount | integer | |
idSample | array of string |
cancel_record_bulk_edit
Not currently available
Cancels one or more open Aprimo bulk-edit sessions, releasing the record locks those sessions hold, without persisting any changes made during them. Use this to clean up after a preview you decided not to continue, or after apply_record_bulk_edit's commit step failed and left a session open. Confirm-gated: call again with confirmed=true after telling the user which session(s) will be discarded.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
tokens | array of string | Yes | The edit-session tokens to discard (the token returned when a bulk-edit session was started). |
confirmed | boolean | No | Must be true to proceed. Confirm with the user which session(s) to discard, then call again with confirmed=true. |
Returns:
| Field | Type | Description |
|---|---|---|
cancelled | boolean | |
tokenCount | integer |
get_record_bulk_edit_field_list_values
Lists the selectable values for a list-type custom field across one or more open Aprimo bulk-edit sessions (option-list entries, classifications, users, or user groups, depending on the field's dataType) -- the bulk-edit companion to get_record_field_list_values. Pass the edit-session token(s) returned when the bulk-edit session(s) were started (see apply_record_bulk_edit). Read-only -- reads the sessions, does not modify them.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fieldId | string | Yes | The field definition id (GUID) whose selectable values to list. |
tokens | array of string | Yes | The bulk-edit session token(s) (from apply_record_bulk_edit) to read list values across. |
filter | string | No | Optional filter expression (DAM query syntax). Omit to list every selectable value. |
sort | string | No | Optional sort expression. Omit for the endpoint's default order. |
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. |
Returns:
| Field | Type | Description |
|---|---|---|
fieldId | string | |
count | integer | |
items | array of RecordFieldListValuePayload | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].kind | string | Best-effort variant classification: "Option", "Classification", "User", "UserGroup", or "Unknown". |
get_record_field_list_values
Lists the selectable values for a list-type custom field on an Aprimo record (option-list entries, classifications, users, or user groups, depending on the field's dataType) — not the field's current value(s); use get_record_field for that. Use filter/sort to narrow a long option set.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
fieldId | string | Yes | The field definition id (GUID) whose selectable values to list. |
filter | string | No | Optional filter expression (DAM query syntax). Omit to list every selectable value. |
sort | string | No | Optional sort expression. Omit for the endpoint's default order. |
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. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
fieldId | string | |
count | integer | |
items | array of RecordFieldListValuePayload | |
items[].id | string | |
items[].name | string (optional) | |
items[].label | string (optional) | |
items[].kind | string | Best-effort variant classification: "Option", "Classification", "User", "UserGroup", or "Unknown". |
preview_record_bulk_edit
Not currently available
Previews a bulk edit (status, content type, and/or field changes) across multiple Aprimo records in one call. Read-only dry run -- changes nothing and does not lock any record (it never opens a DAM edit session). Returns the affected record count, a sample of the record ids, the resolved field add/remove diff, and a confirm_token. To actually apply the change, call apply_record_bulk_edit next with the exact same arguments plus that confirm_token and confirmed=true. disable_validations=true is flagged high-risk -- confirm it explicitly with the user before applying. Edits over 1000 records are flagged over_hard_threshold and require acknowledge_large=true on apply.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordIds | array of string | Yes | The record ids (32-char hex) to bulk-edit. |
status | string | No | Optional: lifecycle status to set on every targeted record. |
contentType | string | No | Optional: content type to set on every targeted record. |
fieldsAddOrUpdate | object (map of string) | No | Field values to add or update on every targeted record. JSON object mapping field name to its new string value. |
fieldsRemove | array of string | No | Field names whose value should be cleared on every targeted record. |
disableValidations | boolean | No | High-risk: when true, skips DAM's field and business rule validations for this edit. |
Returns:
| Field | Type | Description |
|---|---|---|
affectedCount | integer | |
idSample | array of string | |
proposed | RecordStartBulkEditSessionCommand | |
proposed.ids | array of string | |
proposed.status | string (optional) | |
proposed.contentType | string (optional) | |
proposed.fields | FieldCollectionModel | |
proposed.fields.addOrUpdate | array of FieldModel | |
proposed.fields.remove | array of FieldModel | |
proposed.disableValidations | boolean | |
disableValidationsWarning | string (optional) | Non-null only when disableValidations=true — see BulkEditTools.BuildDisableValidationsWarning. |
overHardThreshold | boolean | True when the record count exceeds BulkEditTools.HardThreshold — apply then requires acknowledge_large=true. |
confirmToken | string |
sanitize_record_field_html
Sanitizes HTML content for an Aprimo record field, stripping disallowed tags/attributes/styles per the field's configured allow-list. Stateless utility — does not write the result back to the record; pass the returned cleanValue to update_record_metadata_field yourself if you want to save it. Safe to call without user confirmation — it never modifies data.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
fieldId | string | Yes | The field definition id (GUID) whose HTML allow-list to sanitize against. |
value | string | Yes | The HTML content to sanitize. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
fieldId | string | |
dirty | boolean | |
cleanValue | string (optional) | |
removedTags | array of string | |
removedAttributes | array of string | |
removedStyles | array of string | |
removedAtRules | array of string | |
removedComments | array of string | |
removedCssClasses | array of string | |
filteredUrls | array of string |
update_file_preview_rotation
Sets the rotation angle (in degrees) of a file preview on an Aprimo asset by its id. This modifies data. Always confirm the exact file preview and the new angle with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filePreviewId | string | Yes | The file preview id (32-char hex, from list_file_previews or get_file_preview). |
rotationAngle | integer | Yes | The rotation angle to apply, in degrees (e.g. 90, 180, 270). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
rotationAngle | integer |
update_record_metadata_field
Updates a single metadata field on an Aprimo record. Supports text, number, date, text-list, and option list fields. Use get_record_metadata first to discover field names and IDs. Use get_custom_field_definition to check field constraints and valid option values. Provide either fieldName or fieldId to identify the field (not both). Provide either value (for single-value fields), values (for multi-value fields like text-list or option list), or set clear=true to clear the field. The languageId is required — get it from get_record_metadata results (each field's localizedValues[].languageId).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record ID (GUID format). |
languageId | string | Yes | The language ID (GUID format). Get from get_record_metadata results: each field's localizedValues[].languageId. |
fieldName | string | No | The field name to update. Provide either fieldName or fieldId, not both. |
fieldId | string | No | The field definition ID (GUID) to update. Provide either fieldName or fieldId, not both. |
value | string | No | The new value for single-value fields (text, number, date). For dates use ISO 8601 (e.g. "2026-12-31"). For numbers pass as string (e.g. "49.99"). |
values | string | No | The new values for multi-value fields (text-list, option list). For option lists, use option names from get_custom_field_definition. |
clear | boolean | No | Set to true to clear the field value. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
fieldName | string (optional) | |
success | boolean | |
message | string (optional) |
update_record_metadata_fields
Updates multiple metadata fields on an Aprimo record in a single call. Each field edit supports the same options as update_record_metadata_field: provide either fieldName or fieldId to identify the field (not both), then exactly one of value (single-value fields), values (multi-value fields like text-list or option list), or clear=true — plus the required languageId for that field. Use get_record_metadata first to discover field names and IDs. Use get_custom_field_definition to check field constraints and valid option values. All field edits are validated before any change is applied — if one edit is invalid, the whole call fails and nothing is updated (no partial application). Prefer this over calling update_record_metadata_field repeatedly when updating more than one field on the same record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record ID (GUID format). |
fields | array of FieldEditInput | Yes | The field edits to apply, one per field. Each entry supports fieldName/fieldId (provide one), value/values/clear (provide exactly one), and languageId (required) — the same per-field rules as update_record_metadata_field. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
updatedFields | array of string | |
success | boolean | |
message | string (optional) |
validate_record_field_html
Validates HTML content for an Aprimo record field against the field's allow-list, without modifying anything. Stateless utility, safe to call without user confirmation. Use sanitize_record_field_html if you want the content cleaned rather than just checked.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
fieldId | string | Yes | The field definition id (GUID) whose HTML allow-list to validate against. |
value | string | Yes | The HTML content to validate. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
fieldId | string | |
valid | boolean | |
parseError | string (optional) |
Check Out, Check In & Lock
Can change data · 11 tools (9 currently available) · Group ID check-out-in-lock
Needs: Find & Discover Content, View Files & Versions, Upload & Create Content
| Tool | What it does |
|---|---|
cancel_record_checkout | Destructive. Undoes/cancels an Aprimo record checkout, releasing its lock -- this is the execute step for the undo-checkout flow (there is no separate execute op; see prepare_undo_record_checkout's own description). |
check_out_file | Checks out a file on an Aprimo asset, locking it so other users can't add a new file version while it's checked out. |
execute_record_checkin | Not currently available. Step 2 of 2 for checking in a new file version: finalizes the check-in using the operation_token from prepare_record_checkin, after the new file's bytes have been uploaded to that call's sasUrl. |
execute_record_checkout | Step 2 of 2 for checking out a record: starts the checkout using the operation_token from prepare_record_checkout. |
get_record_checkout_status | Checks the status of an Aprimo record checkout started by execute_record_checkout (which creates an asynchronous download order) -- pass the same operation_token used there. |
list_record_locks | Lists every lock currently held on an Aprimo record: who/what holds each lock (integrationId), why (reason), an optional reference uri, and when it was taken. |
lock_record | Creates a lock on an Aprimo record, preventing it from being modified by others until the lock is released. |
prepare_record_checkin | Not currently available. Step 1 of 2 for checking in a new file version on an Aprimo record: requests an upload location (sasUrl) and registers the previews/publication items to generate once the upload completes. |
prepare_record_checkout | Step 1 of 2 for checking out an Aprimo record: reserves the checkout and returns an operation_token. |
prepare_undo_record_checkout | Step 1 of 2 for undoing an existing checkout on an Aprimo record: reserves the undo and returns an operation_token. |
undo_file_checkout | Destructive. Undoes the checkout lock on a file of an Aprimo asset, releasing it without adding a new file version. |
cancel_record_checkout
Destructive
Undoes/cancels an Aprimo record checkout, releasing its lock -- this is the execute step for the undo-checkout flow (there is no separate execute op; see prepare_undo_record_checkout's own description). Call prepare_undo_record_checkout first to get an operation_token for the record, then pass it here. This cannot be undone (any changes made to a checked-out copy outside DAM are not reconciled by this call). Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact record/operation with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
operationToken | string | Yes | The operation token returned by prepare_undo_record_checkout for the record whose checkout to cancel. |
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 record/operation. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) -- undoing a checkout cannot be undone. Set only after stating the exact record/operation to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
operationToken | string | |
cancelled | 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.
check_out_file
Checks out a file on an Aprimo asset, locking it so other users can't add a new file version while it's checked out. This modifies data. The lock is released automatically when a new file version is added, or explicitly via undo_file_checkout.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
checkedOut | boolean |
execute_record_checkin
Not currently available
Step 2 of 2 for checking in a new file version: finalizes the check-in using the operation_token from prepare_record_checkin, after the new file's bytes have been uploaded to that call's sasUrl. This modifies data -- make sure the user has already confirmed this check-in (at the prepare step or now).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
operationToken | string | Yes | The operation token returned by prepare_record_checkin. |
Returns:
| Field | Type | Description |
|---|---|---|
operationToken | string | |
completed | boolean |
execute_record_checkout
Step 2 of 2 for checking out a record: starts the checkout using the operation_token from prepare_record_checkout. This creates an asynchronous download order -- poll get_record_checkout_status with the same operation_token to see when it's ready and get the delivered file(s). This modifies data -- make sure the user has already confirmed this checkout (at the prepare step or now).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
operationToken | string | Yes | The operation token returned by prepare_record_checkout. |
Returns:
| Field | Type | Description |
|---|---|---|
operationToken | string | |
completed | boolean |
get_record_checkout_status
Checks the status of an Aprimo record checkout started by execute_record_checkout (which creates an asynchronous download order) -- pass the same operation_token used there. Pending/Queued/Executing/Scheduled/AsyncPending/AsyncExecuting are normal in-progress states, not errors -- tell the user it's still processing and offer to check again shortly. deliveredFiles lists the file name(s)/URI(s) the order has produced once status is Success. Note: DAM's spec does not explicitly document how this endpoint is scoped to one checkout order -- modeled here as requiring the operation_token, for consistency with the rest of this checkin/checkout family; unverified against a live tenant.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
operationToken | string | Yes | The operation token returned by prepare_record_checkout (the same one passed to execute_record_checkout). |
Returns:
| Field | Type | Description |
|---|---|---|
operationToken | string | |
status | string | |
deliveredFiles | array of string |
list_record_locks
Lists every lock currently held on an Aprimo record: who/what holds each lock (integrationId), why (reason), an optional reference uri, and when it was taken. Any user with read permission on the record can see its locks. Use before lock_record, or to check whether a record is already locked by another integration before attempting to modify it.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
count | integer | |
items | array of RecordLockPayload | |
items[].lockId | string | |
items[].integrationId | string (optional) | |
items[].uri | string (optional) | |
items[].reason | string (optional) | |
items[].lockedOn | string (optional) |
lock_record
Creates a lock on an Aprimo record, preventing it from being modified by others until the lock is released. This modifies data -- confirm with the user which record to lock and why before calling. There is no unlock/release tool in this API surface; locks are released by the integration that owns them through DAM's own mechanisms.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID) to lock. |
integrationId | string | Yes | Identifier of the integration/system that owns this lock. Required -- confirmed live that DAM 400s ("ArgumentException: integrationId") without it, despite the OpenAPI snapshot not marking it required. |
reason | string | Yes | A human-readable reason for the lock. Required -- confirmed live that DAM 400s ("ArgumentException: reason") without it, despite the OpenAPI snapshot not marking it required. |
uri | string | No | Optional: a URI associated with the lock, e.g. a link back to the external system holding it. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
lockId | string |
prepare_record_checkin
Not currently available
Step 1 of 2 for checking in a new file version on an Aprimo record: requests an upload location (sasUrl) and registers the previews/publication items to generate once the upload completes. The caller must then upload the new file's bytes to the returned sasUrl (a direct-to-Azure-Storage upload, outside this API), then call execute_record_checkin with the returned operation_token to finalize the check-in. This modifies data (reserves an upload session) -- confirm with the user before calling.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID) to check a new file version in on. |
uploadServiceUrl | string | No | Optional: the URL of the upload service that will host the new file version. |
fileName | string | No | Optional: the name of the file being checked in. |
versionLabel | string | No | Optional: a version label to apply to the new file version. |
comment | string | No | Optional: a comment to associate with the new file version. |
previews | array of DamModels.UploadPreviewModel | No | Optional: previews to generate for the new file version, each { fileName, name, pageNumber }. |
publicationItems | array of DamModels.PublicationItemModel | No | Optional: publication items to associate with the new file version, each { targetFileVersionId, pageNumber }. |
authorizationHeader | string | No | Optional: the authorization header to use when uploading to uploadServiceUrl. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
operationToken | string | |
sasUrl | string (optional) | |
previewUploadUrls | array of string |
prepare_record_checkout
Step 1 of 2 for checking out an Aprimo record: reserves the checkout and returns an operation_token. Call execute_record_checkout next with this operation_token to actually start the checkout (which creates an asynchronous download order -- poll get_record_checkout_status with the same token). This modifies data -- confirm with the user before calling.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID) to check out. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
operationToken | string |
prepare_undo_record_checkout
Step 1 of 2 for undoing an existing checkout on an Aprimo record: reserves the undo and returns an operation_token. Call cancel_record_checkout next with this operation_token to actually undo the checkout and release its lock (there is no dedicated execute step for undo -- cancel_record_checkout is that step; see its own description). This modifies data -- confirm with the user before calling.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID) whose checkout to undo. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
operationToken | string |
undo_file_checkout
Destructive
Undoes the checkout lock on a file of an Aprimo asset, releasing it without adding a new file version. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact file with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | string | Yes | The file id (32-char hex, from a record's master file). |
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 file. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — undoing a checkout discards the lock; any in-progress expectation of adding a new version is lost. Set only after stating the exact file to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | string | |
undone | 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 Records
Can change data · 1 tool · Group ID delete-records
Needs: Find & Discover Content
| Tool | What it does |
|---|---|
delete_record | Destructive. Permanently and irreversibly deletes an Aprimo record -- all its files, versions, metadata, and history are gone. |
delete_record
Destructive
Permanently and irreversibly deletes an Aprimo record -- all its files, versions, metadata, and history are gone. This is the most destructive, least recoverable operation in this entire API -- there is no undo. Requires both confirmed=true and confirmedDestructive=true, after explicitly stating the exact record (id, and title if known from get_record_metadata) to the user and getting unambiguous go-ahead. forceDelete additionally overrides a usage lock on the record (requires the caller to hold DAM's 'Override Delete Usage Lock' permission) -- only set it when the user has explicitly asked to force past a lock.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex / GUID) to permanently delete. |
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 record. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) -- deleting a record is permanent and cannot be undone. Set only after stating the exact record to the user and getting explicit go-ahead. |
forceDelete | boolean | No | Optional: when true, force-deletes the record even if it is locked by a usage lock. Requires the caller to hold the 'Override Delete Usage Lock' permission. Only set when the user explicitly asked to force past a lock. |
immediateSearchIndexUpdate | boolean | No | Optional: when true, updates the search index immediately instead of waiting for the next scheduled update. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
deleted | boolean | |
forceDeleted | 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.
Annotate & Comment on Content
Can change data · 3 tools · Group ID annotate-comment-on-content
Needs: View Files & Versions
| Tool | What it does |
|---|---|
create_annotation | Creates a new Aprimo annotation (a comment or XFDF markup) on a file version's page, optionally as a reply to another annotation. |
get_annotation | Gets one Aprimo annotation's detail (comments, XFDF markup, page number, the file version/collection/parent annotation it belongs to) by id. |
list_annotations | Lists the Aprimo annotations (comments/markup attached to file version pages, used for collaborative review). |
create_annotation
Creates a new Aprimo annotation (a comment or XFDF markup) on a file version's page, optionally as a reply to another annotation. This modifies data. Always confirm the file version, page, and comment/markup content with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileVersionId | string | Yes | The id (GUID) of the file version this annotation is placed on. |
pageNumber | integer | No | Page number the annotation is placed on. Omit if not page-specific. |
comments | string | No | Comment text for the annotation. |
xfdfString | string | No | Required (not actually optional — DAM has no supported plain-comment-with-no-markup annotation shape; DAM's own create-annotation validation rejects an empty/missing value). XFDF markup describing the annotation's shape and position. |
parentAnnotationId | string | No | The id (GUID) of the parent annotation, when this annotation is a reply. Omit for a top-level annotation. |
taggedUserIds | array of string | No | User ids (GUIDs) tagged in this annotation. Omit for none. |
collectionId | string | No | The id (GUID) of the collection this annotation belongs to, if any. |
createdBy | string | No | The id (GUID) of the user creating the annotation. Omit to let DAM default to the caller. |
id | string | No | Optional specific id (GUID) for the new annotation. DAM itself requires a non-empty id and never generates one server-side — when omitted, mcp generates a new GUID client-side so callers don't have to. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileVersionId | string | |
pageNumber | integer (optional) |
get_annotation
Gets one Aprimo annotation's detail (comments, XFDF markup, page number, the file version/collection/parent annotation it belongs to) by id. Use after list_annotations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | The annotation id (GUID), from list_annotations. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileVersionId | string (optional) | |
parentAnnotationId | string (optional) | |
collectionId | string (optional) | |
pageNumber | integer (optional) | |
comments | string (optional) | |
xfdfString | string (optional) | |
createdBy | string (optional) | |
modifiedBy | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
list_annotations
Lists the Aprimo annotations (comments/markup attached to file version pages, used for collaborative review). Use when the user asks what annotations exist on a file version/collection, or to look up an annotation's id before calling get_annotation.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "FileVersionId=...". Omit to list every annotation the caller may see. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
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. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of AnnotationPayload | |
items[].id | string | |
items[].fileVersionId | string (optional) | |
items[].parentAnnotationId | string (optional) | |
items[].collectionId | string (optional) | |
items[].pageNumber | integer (optional) | |
items[].comments | string (optional) | |
items[].xfdfString | string (optional) | |
items[].createdBy | string (optional) | |
items[].modifiedBy | string (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
Organize Content into Collections
Can change data · 12 tools · Group ID organize-content-into-collections
Needs: Find & Discover Content, Look Up DAM Users & Groups
| Tool | What it does |
|---|---|
add_records_to_collection | Adds assets (records) to an existing static Aprimo collection. |
create_collection | Creates a new static Aprimo collection. |
create_collection_comment | Creates a new comment on an Aprimo collection. |
delete_collection | Destructive. Permanently deletes an Aprimo collection by id or name. |
delete_collection_comment | Destructive. Permanently deletes a comment from an Aprimo collection. |
get_collection_comment | Gets one comment on an Aprimo collection by collection id and comment id. |
get_collection_comments_status | Gets the count of unread comments (for the calling user) on an Aprimo collection. |
list_collection_comments | Lists the comments on an Aprimo collection. |
list_collection_permissions | Lists the full current permissions of an Aprimo collection (per-user and per-user-group grants, public permission, the calling user's own read/modify rights, content-sharing settings) by id or name. |
mark_collection_comments_read | Marks every comment on an Aprimo collection created on or before a given date as read (for the calling user). |
update_collection | Edits an existing Aprimo collection by id or name. |
update_collection_comment | Edits the text of an existing comment on an Aprimo collection. |
add_records_to_collection
Adds assets (records) to an existing static Aprimo collection. This modifies data. Always confirm with the user which records go into which collection before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID). |
recordIds | string | Yes | The record ids to add (32-char hex each, e.g. from search results). |
Returns:
| Field | Type | Description |
|---|---|---|
collectionId | string | |
addedRecordIds | array of string |
create_collection
Creates a new static Aprimo collection. This modifies data. Always confirm the collection name (and description, if any) with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new collection, exactly as the user stated it. |
description | string | No | Optional description for the collection. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
create_collection_comment
Creates a new comment on an Aprimo collection. This modifies data. Always confirm the comment text with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID) to comment on. |
message | string | Yes | Text of the comment, exactly as the user stated it. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
collectionId | string | |
message | string |
delete_collection
Destructive
Permanently deletes an Aprimo collection by id or name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact collection with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | No | The collection id (32-char hex / GUID) to delete. Provide exactly one of collectionId or name. |
name | string | No | The collection's exact name (case-insensitive). Provide exactly one of collectionId or name. |
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 collection. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a collection is permanent and cannot be undone. Set only after stating the exact collection 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_collection_comment
Destructive
Permanently deletes a comment from an Aprimo collection. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact comment with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID). |
commentId | string | Yes | The comment id (32-char hex / GUID) to delete. |
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 comment. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a comment is permanent and cannot be undone. Set only after stating the exact comment to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
collectionId | string | |
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_collection_comment
Gets one comment on an Aprimo collection by collection id and comment id.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID). |
commentId | string | Yes | The comment id (32-char hex / GUID), from list_collection_comments. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
collectionId | string | |
contextId | integer (optional) | |
message | string | |
read | boolean (optional) | Whether the calling user has read this comment. Null if not requested/available. |
version | integer (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_collection_comments_status
Gets the count of unread comments (for the calling user) on an Aprimo collection.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
collectionId | string | |
unreadComments | integer |
list_collection_comments
Lists the comments on an Aprimo collection. Use to look up a comment's id before calling get/update/delete_collection_comment.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID). |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
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. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionId | string | |
count | integer | |
items | array of CommentPayload | |
items[].id | string | |
items[].collectionId | string | |
items[].contextId | integer (optional) | |
items[].message | string | |
items[].read | boolean (optional) | Whether the calling user has read this comment. Null if not requested/available. |
items[].version | integer (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_collection_permissions
Lists the full current permissions of an Aprimo collection (per-user and per-user-group grants, public permission, the calling user's own read/modify rights, content-sharing settings) by id or name. This is a read; to change these permissions use preview_collection_permissions/apply_collection_permissions instead.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | No | The collection id (32-char hex / GUID). Provide exactly one of collectionId or name. |
name | string | No | The collection's exact name (case-insensitive). Provide exactly one of collectionId or name. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionId | string | |
permissions | array of CollectionUserPermissionEntryPayload | |
permissions[].userId | string | |
permissions[].permission | string | |
groupsPermissions | array of CollectionGroupPermissionEntryPayload | |
groupsPermissions[].groupId | string | |
groupsPermissions[].permission | string | |
publicPermission | string (optional) | |
canRead | boolean (optional) | |
canModify | boolean (optional) | |
contentSharingEnabled | boolean (optional) | |
contentSharingExpiryDate | string (optional) | |
contentPermission | string (optional) |
mark_collection_comments_read
Marks every comment on an Aprimo collection created on or before a given date as read (for the calling user). This modifies data (read state).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID). |
lastReadCommentDate | string | Yes | ISO-8601 timestamp; comments created on or before this date are marked as read. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionId | string | |
unreadComments | integer |
update_collection
Edits an existing Aprimo collection by id or name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact collection and the new values with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | No | The collection id (32-char hex / GUID) to edit. Provide exactly one of collectionId or name. |
name | string | No | The collection's current exact name (case-insensitive), used to look it up. Provide exactly one of collectionId or name. |
newName | string | No | New name for the collection. Omit to leave the name unchanged. |
description | string | No | New description for the collection. Omit to leave it unchanged. |
status | string | No | New lifecycle status: "Active" or "Archived". Omit to leave it unchanged. Use delete_collection (not "Deleted") to remove a collection. |
tag | string | No | New custom XML tag. Omit to leave it unchanged. |
searchAllLanguages | boolean | No | When set, matches this (dynamic) collection's search expression against records in all languages. Omit to leave it unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
update_collection_comment
Edits the text of an existing comment on an Aprimo collection. This modifies data. Always confirm the new text with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
collectionId | string | Yes | The collection id (32-char hex / GUID). |
commentId | string | Yes | The comment id (32-char hex / GUID) to edit. |
content | string | Yes | New text for the comment. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
collectionId | string | |
content | string |
Manage Content Subscriptions
Can change data · 5 tools · Group ID manage-content-subscriptions
Needs: Find & Discover Content, Look Up DAM Users & Groups
| Tool | What it does |
|---|---|
create_subscription | Creates a new Aprimo subscription: subscribes a user to a record or collection for a given change type. |
delete_subscriptions_for_object | Permanently deletes the calling user's own subscription(s) (Follow and/or Expiry) on one Aprimo record or collection. |
get_subscription_by_key | Gets one Aprimo subscription by its composite key: the subscribed object id, the subscribed user id, and the subscription type (Follow or Expiry). |
get_subscription_for_object | Gets the subscription(s) (Follow and/or Expiry) on one Aprimo record or collection. |
list_subscriptions | Lists every user subscribed to an Aprimo record or collection for a given subscription type. |
create_subscription
Creates a new Aprimo subscription: subscribes a user to a record or collection for a given change type. This modifies data. Always confirm the exact user, object, and subscription type with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectId | string | Yes | The record or collection id (32-char hex) to subscribe to. |
userId | string | Yes | The id (GUID) of the user the subscription belongs to. |
subscriptionType | string | Yes | The subscription type. One of: Follow, Expiry. |
subscriptionObjectType | string | Yes | The type of the object being subscribed to. One of: Record, Collection. |
Returns:
| Field | Type | Description |
|---|---|---|
subscriptionId | string | |
objectId | string | |
userId | string | |
subscriptionType | string | |
subscriptionObjectType | string |
delete_subscriptions_for_object
Permanently deletes the calling user's own subscription(s) (Follow and/or Expiry) on one Aprimo record or collection. This is self-scoped -- it only removes the caller's own subscription and does not affect other users' subscriptions to the same object. Always confirm the exact object with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectId | string | Yes | The record or collection id (32-char hex) whose subscription(s) for the calling user will be deleted. |
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 object. |
Returns:
| Field | Type | Description |
|---|---|---|
objectId | string | |
deleted | boolean |
get_subscription_by_key
Gets one Aprimo subscription by its composite key: the subscribed object id, the subscribed user id, and the subscription type (Follow or Expiry). Use when you already know all three and want that specific subscription's detail (rather than every user subscribed to an object — use list_subscriptions for that).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectId | string | Yes | The record or collection id (32-char hex) the subscription applies to. |
userId | string | Yes | The subscribed user's id (GUID). |
subscriptionType | string | Yes | The subscription type. One of: Follow, Expiry. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
objectId | string | |
userId | string | |
subscriptionType | string (optional) | |
subscriptionObjectType | string (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_subscription_for_object
Gets the subscription(s) (Follow and/or Expiry) on one Aprimo record or collection. Warning: confirmed live against a real tenant that this endpoint returns "not found" even when the calling user genuinely has an active Follow and/or Expiry subscription on the object -- it does not reliably reflect subscription state. Prefer get_subscription_by_key (objectId + userId + a specific subscriptionType) or list_subscriptions (objectId + subscriptionType + objectType, then filter for the caller's own userId) instead of trusting this tool's "no subscription" result.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectId | string | Yes | The record or collection id (32-char hex) to check the calling user's subscription(s) on. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of SubscriptionPayload | |
items[].id | string | |
items[].objectId | string | |
items[].userId | string | |
items[].subscriptionType | string (optional) | |
items[].subscriptionObjectType | string (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_subscriptions
Lists every user subscribed to an Aprimo record or collection for a given subscription type. Requires the object id, its subscription type (Follow or Expiry), and its object type (Record or Collection). Use to see who is following/watching an object.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectId | string | Yes | The record or collection id (32-char hex) to list subscribers for. |
subscriptionType | string | Yes | The subscription type. One of: Follow, Expiry. |
objectType | string | Yes | The type of the subscribed object. One of: Record, Collection. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of SubscriptionPayload | |
items[].id | string | |
items[].objectId | string | |
items[].userId | string | |
items[].subscriptionType | string (optional) | |
items[].subscriptionObjectType | string (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |