Task Documents & Attachments
Tools for the documents and files attached to tasks and assignments — uploading and associating documents, supporting and working attachments, and the tasks a given attachment is required on.
This page covers 20 tools, 6 of them 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 |
|---|---|---|
associate_uploaded_document_with_task | On request | Associates an uploaded document version with a task's document-upload instruction, in Aprimo Marketing Operations. |
create_task_document_attachment | On request | Creates an attachment for a task document, by task ID and task-document ID, in Aprimo Marketing Operations. |
create_task_document_attachment_version | On request | Creates a new version of a task document's attachment, by task ID, task-document ID, and attachment ID, in Aprimo Marketing Operations. |
create_task_document_upload | On request | Creates a task document-upload requirement for a task, in Aprimo Marketing Operations. |
delete_task_document_uploaded_version | On request | Destructive. Permanently deletes an uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations. |
get_review_required_documents | On request | Returns all tasks that a given attachment is required on (paged), by the attachment's integer ID, in Aprimo Marketing Operations. |
get_review_task_supporting_attachment | On request | Returns a single supporting (reference/background) attachment for a review task, by review task ID and document ID, in Aprimo Marketing Operations. |
get_task_document_assets | On request | Returns the asset documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations -- same response shape as get_task_documents. |
get_task_document_attachments | On request | Returns the attachment documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations -- same response shape as get_task_documents. |
get_task_document_upload | Default | Returns a single task document-upload requirement by task ID and task-document ID, in Aprimo Marketing Operations. |
get_task_document_uploaded_version | On request | Returns detail for one uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations. |
get_task_document_uploaded_versions | On request | Lists the uploaded versions of a task document, by task ID and task-document ID, in Aprimo Marketing Operations. |
get_task_documents | On request | Returns the documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations. |
get_task_supporting_attachment | Default | Returns a single supporting (reference/background) attachment for a (non-review) task, by task ID and document ID, in Aprimo Marketing Operations. |
get_task_working_attachment | On request | Returns a single working attachment document for a task, by task ID and document ID, in Aprimo Marketing Operations. |
list_review_task_supporting_attachments | Default | Lists supporting (reference/background) attachments for a review task, by the review task's integer ID, in Aprimo Marketing Operations. |
list_task_document_uploads | Default | Lists the document-upload requirements for a task, in Aprimo Marketing Operations. |
list_task_supporting_attachments | Default | Lists supporting (reference/background) attachments for a (non-review) task, by the task's integer ID, in Aprimo Marketing Operations. |
list_task_working_attachments | Default | Lists all working attachment documents for a task, in Aprimo Marketing Operations. |
update_assignment_document | On request | Updates the metadata of a required document attached to a workflow task assignment, by the task-document's integer ID, in Aprimo Marketing Operations. |
associate_uploaded_document_with_task
Available on request
Associates an uploaded document version with a task's document-upload instruction, in Aprimo Marketing Operations. Records a project audit-trail entry. No review-task route exists for this op. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. the uploaded document/version identifiers). Requires confirmed=true after showing the user the exact payload.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
body | string | Yes | JSON object with the uploaded document association data (PM wire names). PM's schema declares this opaque. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
taskDocumentId | integer (optional) | |
raw | object (optional) |
create_task_document_attachment
Available on request
Creates an attachment for a task document, by task ID and task-document ID, in Aprimo Marketing Operations. No review-task route exists for this op. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects. Requires confirmed=true after showing the user the exact payload. Resolves modified-by/creator user names.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
body | string | Yes | JSON object with the attachment data (PM wire names). PM's schema declares this opaque. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
attachmentId | integer | |
title | string (optional) | |
description | string (optional) | |
objectId | integer | |
objectTypeId | integer | |
attachmentTypeId | integer (optional) | |
attachmentType | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
modifiedDate | string (optional) | |
creatorId | integer (optional) | |
creatorName | string (optional) | |
documentId | integer | |
documentName | string (optional) | |
documentType | string (optional) | |
isDocumentDamAsset | boolean (optional) | |
damRecordId | string (optional) | |
isReferenceDocument | boolean |
create_task_document_attachment_version
Available on request
Creates a new version of a task document's attachment, by task ID, task-document ID, and attachment ID, in Aprimo Marketing Operations. No review-task route exists for this op. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects. Requires confirmed=true after showing the user the exact payload. Resolves modified-by/creator user names.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
attachmentId | string | Yes | The attachment's integer ID. |
body | string | Yes | JSON object with the attachment version data (PM wire names). PM's schema declares this opaque. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
versionId | integer | |
isDefaultVersion | boolean | |
attachmentId | integer | |
filename | string (optional) | |
extension | string (optional) | |
downloadUri | string (optional) | |
thumbnailUri | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
modifiedDate | string (optional) | |
createdDate | string (optional) | |
creatorId | integer (optional) | |
creatorName | string (optional) | |
fileSize | integer (optional) | |
documentVersionId | integer | |
documentVersionName | string (optional) | |
attachmentTitle | string (optional) | |
attachmentType | string (optional) | |
hasAnnotations | boolean | |
isDamFileAvailable | boolean |
create_task_document_upload
Available on request
Creates a task document-upload requirement for a task, in Aprimo Marketing Operations. Set isReviewTask=true to create it via the review-task route instead of the plain task route. PM's snapshot declares the request body as fully opaque -- pass the exact wire-shape JSON object PM expects. Requires confirmed=true after showing the user the exact payload.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
body | string | Yes | JSON object with the document-upload requirement data (PM wire names). PM's schema declares this opaque. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
documentId | integer (optional) | |
title | string (optional) | |
category | string (optional) | |
categoryId | integer (optional) | |
assetId | integer (optional) | |
attachmentId | integer (optional) | |
versionId | integer (optional) | |
fileTypeId | integer (optional) | |
uploadTypeId | integer (optional) | |
instructions | string (optional) | |
documentsRequiredType | integer (optional) | |
allowVersionId | integer (optional) | |
uploadLocationId | integer (optional) | |
facets | string (optional) | |
searchExpression | string (optional) | |
workflowDocumentId | integer (optional) | |
linkedTaskDocumentId | integer (optional) | |
assetTypeId | integer (optional) | |
attachmentTypeId | integer (optional) | |
initialVersionId | integer (optional) |
delete_task_document_uploaded_version
Available on request · Destructive
Permanently deletes an uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations. This cannot be undone. Set isReviewTask=true to delete it via the review-task route instead of the plain task route. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact version with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
versionId | string | Yes | The document version's integer ID to delete. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting an uploaded document version is permanent and cannot be undone. Set only after stating the exact version to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
taskDocumentId | integer | |
versionId | 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.
get_review_required_documents
Available on request
Returns all tasks that a given attachment is required on (paged), by the attachment's integer ID, in Aprimo Marketing Operations. No review-task route exists for this op. PM's snapshot declares the response items fully opaque, so each entry's full record is included alongside best-effort task/document/title fields.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
attachId | string | Yes | The attachment's integer ID. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of ReviewRequiredDocumentItem | |
items[].taskId | integer (optional) | |
items[].documentId | integer (optional) | |
items[].title | string (optional) | |
items[].category | string (optional) | |
items[].categoryId | integer (optional) | |
items[].assetId | integer (optional) | |
items[].attachmentId | integer (optional) | |
items[].versionId | integer (optional) | |
items[].fileTypeId | integer (optional) | |
items[].uploadTypeId | integer (optional) | |
items[].instructions | string (optional) | |
items[].documentsRequiredType | integer (optional) | |
items[].allowVersionId | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
get_review_task_supporting_attachment
Available on request
Returns a single supporting (reference/background) attachment for a review task, by review task ID and document ID, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The review task's integer ID. |
documentId | string | Yes | The document's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
title | string (optional) | |
raw | object (optional) |
get_task_document_assets
Available on request
Returns the asset documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations -- same response shape as get_task_documents. Set isReviewTask=true to fetch them via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskTypeId | integer (optional) | |
supporting | array of TaskDocumentHrefItem | |
supporting[].href | string (optional) | |
supporting[].contentType | string (optional) | |
working | array of TaskDocumentHrefItem | |
working[].href | string (optional) | |
working[].contentType | string (optional) |
get_task_document_attachments
Available on request
Returns the attachment documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations -- same response shape as get_task_documents. Set isReviewTask=true to fetch them via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskTypeId | integer (optional) | |
supporting | array of TaskDocumentHrefItem | |
supporting[].href | string (optional) | |
supporting[].contentType | string (optional) | |
working | array of TaskDocumentHrefItem | |
working[].href | string (optional) | |
working[].contentType | string (optional) |
get_task_document_upload
In the default tool list
Returns a single task document-upload requirement by task ID and task-document ID, in Aprimo Marketing Operations. Set isReviewTask=true to fetch it via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
documentId | integer (optional) | |
title | string (optional) | |
category | string (optional) | |
categoryId | integer (optional) | |
assetId | integer (optional) | |
attachmentId | integer (optional) | |
versionId | integer (optional) | |
fileTypeId | integer (optional) | |
uploadTypeId | integer (optional) | |
instructions | string (optional) | |
documentsRequiredType | integer (optional) | |
allowVersionId | integer (optional) | |
uploadLocationId | integer (optional) | |
facets | string (optional) | |
searchExpression | string (optional) | |
workflowDocumentId | integer (optional) | |
linkedTaskDocumentId | integer (optional) | |
assetTypeId | integer (optional) | |
attachmentTypeId | integer (optional) | |
initialVersionId | integer (optional) |
get_task_document_uploaded_version
Available on request
Returns detail for one uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations. Set isReviewTask=true to fetch it via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
versionId | string | Yes | The document version's integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
documentId | integer | |
versionId | integer | |
canUndoLatestUpload | boolean | |
canUndoLatestUploadForTipModifier | boolean | |
uploadedByCurrentUser | boolean | |
currentTaskVersionId | integer | |
isNewerVersion | boolean |
get_task_document_uploaded_versions
Available on request
Lists the uploaded versions of a task document, by task ID and task-document ID, in Aprimo Marketing Operations. Set isReviewTask=true to list them via the review-task route instead of the plain task route.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
taskDocumentId | string | Yes | The task-document's integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of DocumentVersionProjection | |
items[].versionId | integer | |
items[].isDefaultVersion | boolean | |
items[].hasXfdfAnnotations | boolean | |
items[].isEligibleForDamContent | boolean |
get_task_documents
Available on request
Returns the documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations. Set isReviewTask=true to fetch them via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskTypeId | integer (optional) | |
supporting | array of TaskDocumentHrefItem | |
supporting[].href | string (optional) | |
supporting[].contentType | string (optional) | |
working | array of TaskDocumentHrefItem | |
working[].href | string (optional) | |
working[].contentType | string (optional) |
get_task_supporting_attachment
In the default tool list
Returns a single supporting (reference/background) attachment for a (non-review) task, by task ID and document ID, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
documentId | string | Yes | The document's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
title | string (optional) | |
raw | object (optional) |
get_task_working_attachment
Available on request
Returns a single working attachment document for a task, by task ID and document ID, in Aprimo Marketing Operations. Set isReviewTask=true to fetch it via the review-task route instead of the plain task route.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
documentId | string | Yes | The document's integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
documentId | integer (optional) | |
title | string (optional) | |
category | string (optional) | |
assetId | integer (optional) | |
attachmentId | integer (optional) | |
versionId | integer (optional) | |
fileTypeId | integer (optional) | |
uploadTypeId | integer (optional) | |
instructions | string (optional) | |
documentsRequiredType | integer (optional) | |
allowVersionId | integer (optional) |
list_review_task_supporting_attachments
In the default tool list
Lists supporting (reference/background) attachments for a review task, by the review task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of SupportingAttachmentProjection | |
items[].id | string (optional) | |
items[].title | string (optional) | |
items[].raw | object (optional) |
list_task_document_uploads
In the default tool list
Lists the document-upload requirements for a task, in Aprimo Marketing Operations. Set isReviewTask=true to list them via the review-task route instead of the plain task route.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of TaskDocumentUploadProjection | |
items[].taskId | integer | |
items[].documentId | integer (optional) | |
items[].title | string (optional) | |
items[].category | string (optional) | |
items[].categoryId | integer (optional) | |
items[].assetId | integer (optional) | |
items[].attachmentId | integer (optional) | |
items[].versionId | integer (optional) | |
items[].fileTypeId | integer (optional) | |
items[].uploadTypeId | integer (optional) | |
items[].instructions | string (optional) | |
items[].documentsRequiredType | integer (optional) | |
items[].allowVersionId | integer (optional) | |
items[].uploadLocationId | integer (optional) | |
items[].facets | string (optional) | |
items[].searchExpression | string (optional) | |
items[].workflowDocumentId | integer (optional) | |
items[].linkedTaskDocumentId | integer (optional) | |
items[].assetTypeId | integer (optional) | |
items[].attachmentTypeId | integer (optional) | |
items[].initialVersionId | integer (optional) |
list_task_supporting_attachments
In the default tool list
Lists supporting (reference/background) attachments for a (non-review) task, by the task's integer ID, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of SupportingAttachmentProjection | |
items[].id | string (optional) | |
items[].title | string (optional) | |
items[].raw | object (optional) |
list_task_working_attachments
In the default tool list
Lists all working attachment documents for a task, in Aprimo Marketing Operations. Set isReviewTask=true to list them via the review-task route instead of the plain task route.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's (or review task's) integer ID. |
isReviewTask | boolean | No | When true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of WorkingDocumentProjection | |
items[].taskId | integer | |
items[].documentId | integer (optional) | |
items[].title | string (optional) | |
items[].category | string (optional) | |
items[].assetId | integer (optional) | |
items[].attachmentId | integer (optional) | |
items[].versionId | integer (optional) | |
items[].fileTypeId | integer (optional) | |
items[].uploadTypeId | integer (optional) | |
items[].instructions | string (optional) | |
items[].documentsRequiredType | integer (optional) | |
items[].allowVersionId | integer (optional) |
update_assignment_document
Available on request
Updates the metadata of a required document attached to a workflow task assignment, by the task-document's integer ID, in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects. Requires confirmed=true after showing the user the exact payload.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskDocId | string | Yes | The task-document's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). PM's schema declares this opaque. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
taskDocId | string (optional) | |
raw | object (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