Watermarks
Tools for watermark definitions and their images.
This page covers 6 tools, all of them available on request rather than in the default tool list, and 1 destructive.
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
create_watermark | On request | Creates a new Aprimo watermark. |
delete_watermark | On request | Destructive. Permanently deletes an Aprimo watermark by id or by name. |
get_watermark | On request | Gets one Aprimo watermark's detail (position, custom tag, dates) by id or by name. |
get_watermark_image | On request | Returns the image URL (plus width/height/size/extension) for an Aprimo watermark, by id or by name. |
list_watermarks | On request | Lists the watermarks configured in Aprimo: name, position, id, and dates. |
update_watermark | On request | Edits an existing Aprimo watermark by id or by name. |
create_watermark
Available on request
Creates a new Aprimo watermark. This modifies data. Always confirm the name, position, and image with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new watermark, exactly as the user stated it. |
position | string | Yes | Where the watermark is placed on the asset. One of: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight. |
imageBase64 | string | Yes | Base64-encoded watermark image (e.g. a transparent-background png/logo). |
tag | string | No | Optional custom XML tag associated with the watermark. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
delete_watermark
Available on request · Destructive
Permanently deletes an Aprimo watermark by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact watermark with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
watermarkId | string | No | The watermark id (GUID) to delete. Provide this or name, not both. |
name | string | No | The watermark's name (case-insensitive, exact match). Provide this or watermarkId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact watermark. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a watermark is permanent and cannot be undone. Set only after stating the exact watermark to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_watermark
Available on request
Gets one Aprimo watermark's detail (position, custom tag, dates) by id or by name. Use after list_watermarks, or pass name directly when the user names the watermark. Not its image (use get_watermark_image for that).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
watermarkId | string | No | The watermark id (GUID), from list_watermarks. Provide this or name, not both. |
name | string | No | The watermark's name (case-insensitive, exact match), e.g. "Confidential". Provide this or watermarkId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
position | string | |
tag | string (optional) | |
createdOn | string | |
modifiedOn | string |
get_watermark_image
Available on request
Returns the image URL (plus width/height/size/extension) for an Aprimo watermark, by id or by name. The URL remains valid for twenty-four hours. Important: Display the URL as plain text, never as an HTML img tag.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
watermarkId | string | No | The watermark id (GUID). Provide this or name, not both. |
name | string | No | The watermark's name (case-insensitive, exact match). Provide this or watermarkId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
watermarkId | string | |
uri | string (optional) | |
width | integer (optional) | |
height | integer (optional) | |
size | integer (optional) | |
extension | string (optional) |
list_watermarks
Available on request
Lists the watermarks configured in Aprimo: name, position, id, and dates. Use when the user asks what watermarks exist, or to look up a watermark's id/exact name before calling get_watermark, update_watermark, or delete_watermark by name.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of WatermarkPayload | |
items[].id | string | |
items[].name | string | |
items[].position | string | |
items[].tag | string (optional) | |
items[].createdOn | string | |
items[].modifiedOn | string |
update_watermark
Available on request
Edits an existing Aprimo watermark by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact watermark and the new values with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
watermarkId | string | No | The watermark id (GUID) to edit. Provide this or name, not both. |
name | string | No | The watermark's current name (case-insensitive, exact match), used to look it up. Provide this or watermarkId, not both. |
newName | string | No | New name for the watermark. Omit to leave the name unchanged. |
position | string | No | New position. One of: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight. Omit to leave the position unchanged. |
tag | string | No | New custom XML tag. Omit to leave the tag unchanged. |
imageBase64 | string | No | New base64-encoded watermark image. Omit to leave the image unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent