Downloads & Public Links
Tools for getting content out of the DAM — download agreements and their acceptance, download links, and public links.
This page covers 25 tools, 18 of them in the default tool list, and 4 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 |
|---|---|---|
accept_download_link_agreement | On request | Records the calling user's acceptance of a download's applicable download agreement, confirming they accept the terms in their language version of it. |
accept_record_download_agreement | Default | Records the calling user's acceptance of a record's download agreement, confirming they accept the terms in their language version of it. |
create_download_agreement | Default | Creates a new Aprimo download agreement. |
create_public_link | Default | Destructive. Imports a public link already created in the caller's own CDN into Aprimo — not for having DAM generate one (use submit_public_link for that instead). |
delete_download_agreement | Default | Destructive. Permanently deletes an Aprimo download agreement by id. |
delete_public_link | On request | Destructive. Permanently deletes an Aprimo public link by id — the URL stops working immediately. |
get_download_agreement | Default | Gets one Aprimo download agreement's detail (enabled, creation/modification dates) by id. |
get_download_agreement_content | Default | Gets one Aprimo download agreement content item's detail (language, version, title, terms-of-use text) by its own content id. |
get_download_link | Default | Gets one Aprimo download link's detail (status, delivered files, applicable download agreement ids) by id — the result of a maintenance job that generates downloadable files (a download order, export, or contact sheet). |
get_public_link | On request | Gets one Aprimo public link's detail (uri, status, provider, the record/file version it targets) by id. |
get_record_download_agreement | Default | Gets the applicable Aprimo download agreement's content (title + terms-of-use text) for a record, in the calling user's own language. |
get_rendition | Default | Gets one Aprimo rendition's detail (name, type, extension, uri, preview, published uri) by id. |
get_shared_download_link | On request | Gets one Aprimo shared download link's detail (verification requirement, whether it was emailed, expiration) by id -- not the download URI itself (use get_shared_download_link_file_uri for that). |
get_shared_download_link_file_uri | On request | Gets the download URI (not the file's bytes) for one file attached to an Aprimo shared download link, by shared download link id and file id. |
list_download_agreement_classifications | Default | Lists the classification ids an Aprimo download agreement applies to, by id. |
list_download_agreement_contents | Default | Lists every localized content entry (title + terms-of-use text, per language) of an Aprimo download agreement, by id. |
list_download_agreement_user_groups | Default | Lists the user group ids an Aprimo download agreement applies to, by id. |
list_download_agreements | Default | Lists the download agreements configured in Aprimo — a policy (title + terms-of-use text, scoped to user groups/classifications) users must accept before they can download certain content. |
list_download_link_targets | Default | Lists the target ids of an Aprimo download link by id — which records/files it covers. |
list_download_links | Default | Lists the download links in Aprimo — the results of maintenance jobs that generate downloadable files (download orders, exports, contact sheets). |
list_rendition_public_links | Default | Lists the Aprimo public links pointing at a rendition, by rendition id. |
request_shared_download_link_verification_code | On request | Requests a verification code for an Aprimo shared download link and emails it to the given recipient. |
search_download_agreements | Default | Searches for the Aprimo download agreements applicable to a given set of records. |
update_download_agreement | Default | Edits an existing Aprimo download agreement by id. |
update_public_link | On request | Destructive. Edits an existing Aprimo public link by id (fileSize/renditionName/uri/provider only — the record/file version it targets is fixed at creation). |
accept_download_link_agreement
Available on request
Records the calling user's acceptance of a download's applicable download agreement, confirming they accept the terms in their language version of it. This modifies data. Always show the user the agreement's content (via get_download_agreement_content or get_record_download_agreement) and confirm they accept it, then call again with confirmed=true.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadId | string | Yes | The download's id (the download link's own id, 32-char hex or GUID) whose download agreement is being accepted. |
contentId | integer | Yes | The download agreement content id being accepted. |
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 they accept the agreement's content. |
Returns:
| Field | Type | Description |
|---|---|---|
downloadId | string | |
contentId | integer | |
accepted | boolean |
accept_record_download_agreement
In the default tool list
Records the calling user's acceptance of a record's download agreement, confirming they accept the terms in their language version of it. This modifies data. Always show the user the agreement's content (via get_record_download_agreement) and confirm they accept it before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex or GUID) whose download agreement is being accepted. |
contentId | integer | Yes | The download agreement content id being accepted, from get_record_download_agreement. |
Returns:
| Field | Type | Description |
|---|---|---|
recordId | string | |
contentId | integer | |
accepted | boolean |
create_download_agreement
In the default tool list
Creates a new Aprimo download agreement. Confirmed live against the tenant: DAM allows at most one download agreement tenant-wide -- calling this when one already exists 400s with "Only one download agreement is allowed"; call list_download_agreements first and use update_download_agreement or delete_download_agreement + retry instead if one is already present. This modifies data. Always confirm the localized content, the user groups it applies to, and the classifications it applies to with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
enabled | boolean | No | Whether the download agreement is enabled. Omit to use DAM's default. |
contents | array of DamModels.DownloadAgreementContentModel | No | Required, not actually optional -- confirmed live against the tenant: DAM rejects a download agreement with no content entry for the tenant's English language ("Download agreement content in English is required."), even though the wire schema marks contents fully optional. One entry per language, each with languageId (GUID, required), title, and termsOfUse -- at least one entry must use the languageId of the tenant's English language (from list_languages). |
userGroupIds | array of string | No | Required (not actually optional — DAM rejects a download agreement with no user groups: "The collection UserGroups must contain at least one item."). User group ids (GUIDs) this agreement applies to. |
classificationIds | array of string | No | Classification ids (GUIDs) this agreement applies to. Omit for none. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer |
create_public_link
In the default tool list · Destructive
Imports a public link already created in the caller's own CDN into Aprimo — not for having DAM generate one (use submit_public_link for that instead). This modifies data and makes the target publicly accessible via an unauthenticated URL. This is a disclosure-risk write: requires both confirmed=true and confirmedDestructive=true, after explicitly confirming with the user that the target should be made publicly accessible via this externally-hosted URL.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | No | Id of the record to create the public link for (GUID). Provide this and/or additionalFileId. |
fileVersionId | string | No | Id of the specific file version to create the public link for (GUID). Omit to target the record's master file. |
additionalFileId | string | No | Id of the additional file to create the public link for (GUID). Provide this and/or recordId. |
fileSize | integer | No | Size, in bytes, of the file the public link points to. |
renditionName | string | No | Name of the rendition the public link points to. |
uri | string | No | Required (not actually optional — DAM's create-public-link command validates this is a well-formed absolute URI before anything else, unconditionally, since this tool imports a link to a file already hosted in the caller's own CDN; DAM never generates this URI itself). Storage URI of the file in the caller's own CDN, e.g. "http://your-cdn.example/file.jpg". |
provider | string | No | Storage provider that hosts the file, e.g. the CDN's 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 explicitly confirms the target should be made publicly accessible. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — this exposes content via an externally-hosted, unauthenticated URL. Set only after stating the exact target to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
uri | string (optional) | |
status | string (optional) | |
canDelete | boolean (optional) | |
provider | string (optional) | |
recordId | string (optional) | |
fileVersionId | string (optional) | |
additionalFileId | string (optional) | |
fileSize | integer (optional) | |
renditionName | string (optional) | |
origin | string (optional) | |
modifiedOn | string (optional) | |
createdOn | string (optional) |
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_download_agreement
In the default tool list · Destructive
Permanently deletes an Aprimo download agreement by id. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact download agreement with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadAgreementId | integer | Yes | The download agreement id (integer) 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 download agreement. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a download agreement is permanent and cannot be undone. Set only after stating the exact download agreement to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
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_public_link
Available on request · Destructive
Permanently deletes an Aprimo public link by id — the URL stops working immediately. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact public link with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
publicLinkId | string | Yes | The public link id (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 public link. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a public link is permanent and cannot be undone. Set only after stating the exact public link to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | 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_download_agreement
In the default tool list
Gets one Aprimo download agreement's detail (enabled, creation/modification dates) by id. Not its content (use get_download_agreement_content for that). Use after list_download_agreements. Use list_download_agreement_contents/list_download_agreement_user_groups/list_download_agreement_classifications to see the agreement's localized text and scope.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadAgreementId | integer | Yes | The download agreement id (integer), from list_download_agreements. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
enabled | boolean (optional) | |
createdOn | string (optional) | |
modifiedOn | string (optional) |
get_download_agreement_content
In the default tool list
Gets one Aprimo download agreement content item's detail (language, version, title, terms-of-use text) by its own content id. Use after list_download_agreement_contents.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadAgreementContentId | integer | Yes | The download agreement content id (integer), from list_download_agreement_contents. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
languageId | string (optional) | |
version | integer (optional) | |
title | string (optional) | |
termsOfUse | string (optional) |
get_download_link
In the default tool list
Gets one Aprimo download link's detail (status, delivered files, applicable download agreement ids) by id — the result of a maintenance job that generates downloadable files (a download order, export, or contact sheet). Use after list_download_links, or when you already have the id from another tool's output. Use list_download_link_targets to see which records/files it covers.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadLinkId | string | Yes | The download link id (32-char hex or GUID), from list_download_links. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
type | string (optional) | |
status | string (optional) | |
title | string (optional) | |
description | string (optional) | |
errorDescription | string (optional) | |
deliveredFiles | array of string (optional) | |
failedTargetsCount | integer (optional) | |
succeededRecordsCount | integer (optional) | |
failedRecordsCount | integer (optional) | |
downloadAgreementIds | array of integer (optional) | |
createdOn | string (optional) |
get_public_link
Available on request
Gets one Aprimo public link's detail (uri, status, provider, the record/file version it targets) by id. A public link is a shareable, tokenized URL granting unauthenticated access to a specific file version's content. Use list_rendition_public_links to find a public link's id starting from a rendition.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
publicLinkId | string | Yes | The public link id (GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
uri | string (optional) | |
status | string (optional) | |
canDelete | boolean (optional) | |
provider | string (optional) | |
recordId | string (optional) | |
fileVersionId | string (optional) | |
additionalFileId | string (optional) | |
fileSize | integer (optional) | |
renditionName | string (optional) | |
origin | string (optional) | |
modifiedOn | string (optional) | |
createdOn | string (optional) |
get_record_download_agreement
In the default tool list
Gets the applicable Aprimo download agreement's content (title + terms-of-use text) for a record, in the calling user's own language. Use before accept_record_download_agreement, to show the user what they're accepting and to get its content id.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | The record id (32-char hex or GUID) to get the applicable download agreement for. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
languageId | string (optional) | |
version | integer (optional) | |
title | string (optional) | |
termsOfUse | string (optional) |
get_rendition
In the default tool list
Gets one Aprimo rendition's detail (name, type, extension, uri, preview, published uri) by id. A rendition is a generated derivative of a file version — a thumbnail, resized preview, or converted format — produced by DAM's media processing pipeline. Use list_rendition_public_links to find any public links pointing at this rendition.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
renditionId | string | Yes | The rendition id (GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
uri | string (optional) | |
type | string (optional) | |
name | string (optional) | |
extension | string (optional) | |
preview | string (optional) | |
publishedUri | string (optional) |
get_shared_download_link
Available on request
Gets one Aprimo shared download link's detail (verification requirement, whether it was emailed, expiration) by id -- not the download URI itself (use get_shared_download_link_file_uri for that). A shared download link is a controlled alternative to a plain public link for sharing a set of files with a named recipient by email. Use get_shared_download_link_file_uri to get the download URI for one of its files.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID), from submit_shared_download_link/check_shared_download_link. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
useVerification | boolean (optional) | |
sendEmail | boolean (optional) | |
expiresOn | string (optional) | |
createdOn | string (optional) |
get_shared_download_link_file_uri
Available on request
Gets the download URI (not the file's bytes) for one file attached to an Aprimo shared download link, by shared download link id and file id. If the link requires verification (see get_shared_download_link), pass the recipient's email and the verification code from request_shared_download_link_verification_code.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID). |
fileId | integer | Yes | The file id, from the shared download link's files. |
email | string | No | The recipient's email, for verification. Only required when the link is configured to require verification. |
verificationCode | string | No | The verification code, from request_shared_download_link_verification_code. Only required when the link is configured to require verification. |
Returns:
| Field | Type | Description |
|---|---|---|
fileId | integer | |
sharedDownloadLinkId | string (optional) | |
downloadUri | string (optional) |
list_download_agreement_classifications
In the default tool list
Lists the classification ids an Aprimo download agreement applies to, by id.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadAgreementId | integer | Yes | The download agreement id (integer). |
Returns:
| Field | Type | Description |
|---|---|---|
downloadAgreementId | integer | |
count | integer | |
items | array of DownloadAgreementClassificationPayload | |
items[].classificationId | string |
list_download_agreement_contents
In the default tool list
Lists every localized content entry (title + terms-of-use text, per language) of an Aprimo download agreement, by id. Use to look up a content id before calling get_download_agreement_content.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadAgreementId | integer | Yes | The download agreement id (integer). |
Returns:
| Field | Type | Description |
|---|---|---|
downloadAgreementId | integer | |
count | integer | |
items | array of DownloadAgreementContentPayload | |
items[].id | integer | |
items[].languageId | string (optional) | |
items[].version | integer (optional) | |
items[].title | string (optional) | |
items[].termsOfUse | string (optional) |
list_download_agreement_user_groups
In the default tool list
Lists the user group ids an Aprimo download agreement applies to, by id.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadAgreementId | integer | Yes | The download agreement id (integer). |
Returns:
| Field | Type | Description |
|---|---|---|
downloadAgreementId | integer | |
count | integer | |
items | array of DownloadAgreementUserGroupPayload | |
items[].userGroupId | string |
list_download_agreements
In the default tool list
Lists the download agreements configured in Aprimo — a policy (title + terms-of-use text, scoped to user groups/classifications) users must accept before they can download certain content. Use when the user asks what download agreements exist, or to look up a download agreement's id before calling get_download_agreement, update_download_agreement, or delete_download_agreement.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every download agreement. |
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 DownloadAgreementPayload | |
items[].id | integer | |
items[].enabled | boolean (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
list_download_link_targets
In the default tool list
Lists the target ids of an Aprimo download link by id — which records/files it covers.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadLinkId | string | Yes | The download link id (32-char hex or GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
downloadLinkId | string | |
count | integer | |
items | array of string |
list_download_links
In the default tool list
Lists the download links in Aprimo — the results of maintenance jobs that generate downloadable files (download orders, exports, contact sheets). Use when the user asks what downloads exist or their status, or to look up a download link's id before calling get_download_link, list_download_link_targets, or accept_download_link_agreement.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "CreatedOn in today". Omit to list every download link. |
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 DownloadLinkPayload | |
items[].id | string | |
items[].type | string (optional) | |
items[].status | string (optional) | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].errorDescription | string (optional) | |
items[].deliveredFiles | array of string (optional) | |
items[].failedTargetsCount | integer (optional) | |
items[].succeededRecordsCount | integer (optional) | |
items[].failedRecordsCount | integer (optional) | |
items[].downloadAgreementIds | array of integer (optional) | |
items[].createdOn | string (optional) |
list_rendition_public_links
In the default tool list
Lists the Aprimo public links pointing at a rendition, by rendition id. Use to look up a public link's id before calling get_public_link.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
renditionId | string | Yes | The rendition id (GUID). |
Returns:
| Field | Type | Description |
|---|---|---|
renditionId | string | |
count | integer | |
items | array of PublicLinkPayload | |
items[].id | string | |
items[].uri | string (optional) | |
items[].status | string (optional) | |
items[].canDelete | boolean (optional) | |
items[].provider | string (optional) | |
items[].recordId | string (optional) | |
items[].fileVersionId | string (optional) | |
items[].additionalFileId | string (optional) | |
items[].fileSize | integer (optional) | |
items[].renditionName | string (optional) | |
items[].origin | string (optional) | |
items[].modifiedOn | string (optional) | |
items[].createdOn | string (optional) |
request_shared_download_link_verification_code
Available on request
Requests a verification code for an Aprimo shared download link and emails it to the given recipient. This sends an email. Use when a shared download link requires verification (see get_shared_download_link) and the recipient needs a new code, e.g. before calling get_shared_download_link_file_uri.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
sharedDownloadLinkId | string | Yes | The shared download link id (GUID). |
email | string | Yes | Email address of the recipient who should receive the verification code. |
Returns:
| Field | Type | Description |
|---|---|---|
sharedDownloadLinkId | string | |
requested | boolean |
search_download_agreements
In the default tool list
Searches for the Aprimo download agreements applicable to a given set of records. This is a lookup (read-only), even though DAM exposes it as a POST — no confirmation is required.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
recordIds | array of string | Yes | The record ids (32-char hex or GUID) to find applicable download agreements for. |
filter | string | No | Optional filter expression (DAM query syntax). Omit to apply no additional filter. |
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 DownloadAgreementPayload | |
items[].id | integer | |
items[].enabled | boolean (optional) | |
items[].createdOn | string (optional) | |
items[].modifiedOn | string (optional) |
update_download_agreement
In the default tool list
Edits an existing Aprimo download agreement by id. Only the fields provided are changed — omitted fields are expected to keep their current value (this assumes DAM merges the edit rather than fully replacing the agreement; unverified for this endpoint). This modifies data. Always confirm the exact agreement and the new values with the user before calling this tool. Content entries can only be added or updated (upserted per languageId), never removed, through this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
downloadAgreementId | integer | Yes | The download agreement id (integer) to edit. |
enabled | boolean | No | New enabled flag. Omit to leave it unchanged. |
contentsToAddOrUpdate | array of DamModels.DownloadAgreementContentModel | No | Localized content entries to add or update: one entry per language, each with languageId (GUID, required), title, and termsOfUse. Omit to leave content unchanged. |
userGroupIdsToAdd | array of string | No | User group ids (GUIDs) to add to this agreement's scope. |
userGroupIdsToRemove | array of string | No | User group ids (GUIDs) to remove from this agreement's scope. |
classificationIdsToAdd | array of string | No | Classification ids (GUIDs) to add to this agreement's scope. |
classificationIdsToRemove | array of string | No | Classification ids (GUIDs) to remove from this agreement's scope. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
enabled | boolean (optional) |
update_public_link
Available on request · Destructive
Edits an existing Aprimo public link by id (fileSize/renditionName/uri/provider only — the record/file version it targets is fixed at creation). Only the fields provided are changed — omitted fields are expected to keep their current value (this assumes DAM merges the edit rather than fully replacing the public link; unverified for this endpoint). This modifies data and changes what an already-public, unauthenticated URL points to. This is a disclosure-risk write: requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact public link and the new values with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
publicLinkId | string | Yes | The public link id (GUID) to edit. |
fileSize | integer | No | New size, in bytes, of the file the public link points to. Omit to leave it unchanged. |
renditionName | string | No | New rendition name the public link points to. Omit to leave it unchanged. |
uri | string | No | New storage URI of the file. Omit to leave it unchanged. |
provider | string | No | New storage provider that hosts the file. Omit to leave it unchanged. |
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 explicitly confirms the exact public link and new values. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — this changes what an already-public, unauthenticated URL points to. Set only after stating the exact public link and new values to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
fileSize | integer (optional) | |
renditionName | string (optional) | |
uri | string (optional) | |
provider | string (optional) |
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.
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