Skip to main content

Publish content

Create and manage public links so content can be shared outside Aprimo.

This area has 1 group and 4 tools, 2 of them currently available.

How to read this page
  • 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 confirmed and confirmedDestructive to true.
  • 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​

GroupAccessNeedsTools
Publish Public LinksCan change dataView Public Links4

Can change data · 4 tools (2 currently available) · Group ID publish-public-links

Needs: View Public Links

ToolWhat it does
create_public_linkDestructive. 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_public_linkNot currently available. Destructive. Permanently deletes an Aprimo public link by id — the URL stops working immediately.
submit_public_linkGenerates a DAM public CDN link for one Aprimo asset.
update_public_linkNot currently available. Destructive. Edits an existing Aprimo public link by id (fileSize/renditionName/uri/provider only — the record/file version it targets is fixed at creation).

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:

ParameterTypeRequiredDescription
recordIdstringNoId of the record to create the public link for (GUID). Provide this and/or additionalFileId.
fileVersionIdstringNoId of the specific file version to create the public link for (GUID). Omit to target the record's master file.
additionalFileIdstringNoId of the additional file to create the public link for (GUID). Provide this and/or recordId.
fileSizeintegerNoSize, in bytes, of the file the public link points to.
renditionNamestringNoName of the rendition the public link points to.
uristringNoRequired (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".
providerstringNoStorage provider that hosts the file, e.g. the CDN's name.
confirmedbooleanNoMust 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.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idstring
uristring (optional)
statusstring (optional)
canDeleteboolean (optional)
providerstring (optional)
recordIdstring (optional)
fileVersionIdstring (optional)
additionalFileIdstring (optional)
fileSizeinteger (optional)
renditionNamestring (optional)
originstring (optional)
modifiedOnstring (optional)
createdOnstring (optional)
Destructive operation

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.


Destructive · Not currently available

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:

ParameterTypeRequiredDescription
publicLinkIdstringYesThe public link id (GUID) to delete.
confirmedbooleanNoMust 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.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idstring
deletedboolean
Destructive operation

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.


Generates a DAM public CDN link for one Aprimo asset. This modifies data (creates a DAM order) and makes the asset publicly accessible via an unauthenticated CDN link that stays live until deleted. Always confirm with the user that the asset should be made publicly accessible before calling this tool. Does not return the link immediately — Aprimo processes public CDN orders asynchronously. This tool only returns an order id: after calling it, call check_public_link with that same order id to find out when the link is ready and get it. Use when the user asks for a public link, CDN link, or a shareable direct link to an asset. Do not tell the user the link is ready until check_public_link confirms it.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe record id (32-char hex) of the asset to generate a public CDN link for.
confirmedbooleanNoMust 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 asset should be made publicly accessible.

Returns:

FieldTypeDescription
orderIdstring
statusstring

Destructive · Not currently available

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:

ParameterTypeRequiredDescription
publicLinkIdstringYesThe public link id (GUID) to edit.
fileSizeintegerNoNew size, in bytes, of the file the public link points to. Omit to leave it unchanged.
renditionNamestringNoNew rendition name the public link points to. Omit to leave it unchanged.
uristringNoNew storage URI of the file. Omit to leave it unchanged.
providerstringNoNew storage provider that hosts the file. Omit to leave it unchanged.
confirmedbooleanNoMust 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.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
idstring
fileSizeinteger (optional)
renditionNamestring (optional)
uristring (optional)
providerstring (optional)
Destructive operation

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.