Skip to main content

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.

How to read this page
  • 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 confirmed and confirmedDestructive to true.
  • Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Why isn't every tool in the default list?

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

ToolStatusWhat it does
associate_uploaded_document_with_taskOn requestAssociates an uploaded document version with a task's document-upload instruction, in Aprimo Marketing Operations.
create_task_document_attachmentOn requestCreates an attachment for a task document, by task ID and task-document ID, in Aprimo Marketing Operations.
create_task_document_attachment_versionOn requestCreates 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_uploadOn requestCreates a task document-upload requirement for a task, in Aprimo Marketing Operations.
delete_task_document_uploaded_versionOn requestDestructive. Permanently deletes an uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations.
get_review_required_documentsOn requestReturns all tasks that a given attachment is required on (paged), by the attachment's integer ID, in Aprimo Marketing Operations.
get_review_task_supporting_attachmentOn requestReturns a single supporting (reference/background) attachment for a review task, by review task ID and document ID, in Aprimo Marketing Operations.
get_task_document_assetsOn requestReturns 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_attachmentsOn requestReturns 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_uploadDefaultReturns a single task document-upload requirement by task ID and task-document ID, in Aprimo Marketing Operations.
get_task_document_uploaded_versionOn requestReturns detail for one uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations.
get_task_document_uploaded_versionsOn requestLists the uploaded versions of a task document, by task ID and task-document ID, in Aprimo Marketing Operations.
get_task_documentsOn requestReturns the documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations.
get_task_supporting_attachmentDefaultReturns a single supporting (reference/background) attachment for a (non-review) task, by task ID and document ID, in Aprimo Marketing Operations.
get_task_working_attachmentOn requestReturns a single working attachment document for a task, by task ID and document ID, in Aprimo Marketing Operations.
list_review_task_supporting_attachmentsDefaultLists supporting (reference/background) attachments for a review task, by the review task's integer ID, in Aprimo Marketing Operations.
list_task_document_uploadsDefaultLists the document-upload requirements for a task, in Aprimo Marketing Operations.
list_task_supporting_attachmentsDefaultLists supporting (reference/background) attachments for a (non-review) task, by the task's integer ID, in Aprimo Marketing Operations.
list_task_working_attachmentsDefaultLists all working attachment documents for a task, in Aprimo Marketing Operations.
update_assignment_documentOn requestUpdates 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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
taskDocumentIdstringYesThe task-document's integer ID.
bodystringYesJSON object with the uploaded document association data (PM wire names). PM's schema declares this opaque.
confirmedbooleanNoMust 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:

FieldTypeDescription
taskDocumentIdinteger (optional)
rawobject (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
taskDocumentIdstringYesThe task-document's integer ID.
bodystringYesJSON object with the attachment data (PM wire names). PM's schema declares this opaque.
confirmedbooleanNoMust 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:

FieldTypeDescription
attachmentIdinteger
titlestring (optional)
descriptionstring (optional)
objectIdinteger
objectTypeIdinteger
attachmentTypeIdinteger (optional)
attachmentTypestring (optional)
modifiedByIdinteger (optional)
modifiedByNamestring (optional)
modifiedDatestring (optional)
creatorIdinteger (optional)
creatorNamestring (optional)
documentIdinteger
documentNamestring (optional)
documentTypestring (optional)
isDocumentDamAssetboolean (optional)
damRecordIdstring (optional)
isReferenceDocumentboolean

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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
taskDocumentIdstringYesThe task-document's integer ID.
attachmentIdstringYesThe attachment's integer ID.
bodystringYesJSON object with the attachment version data (PM wire names). PM's schema declares this opaque.
confirmedbooleanNoMust 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:

FieldTypeDescription
versionIdinteger
isDefaultVersionboolean
attachmentIdinteger
filenamestring (optional)
extensionstring (optional)
downloadUristring (optional)
thumbnailUristring (optional)
modifiedByIdinteger (optional)
modifiedByNamestring (optional)
modifiedDatestring (optional)
createdDatestring (optional)
creatorIdinteger (optional)
creatorNamestring (optional)
fileSizeinteger (optional)
documentVersionIdinteger
documentVersionNamestring (optional)
attachmentTitlestring (optional)
attachmentTypestring (optional)
hasAnnotationsboolean
isDamFileAvailableboolean

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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
bodystringYesJSON object with the document-upload requirement data (PM wire names). PM's schema declares this opaque.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.
confirmedbooleanNoMust 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:

FieldTypeDescription
taskIdinteger
documentIdinteger (optional)
titlestring (optional)
categorystring (optional)
categoryIdinteger (optional)
assetIdinteger (optional)
attachmentIdinteger (optional)
versionIdinteger (optional)
fileTypeIdinteger (optional)
uploadTypeIdinteger (optional)
instructionsstring (optional)
documentsRequiredTypeinteger (optional)
allowVersionIdinteger (optional)
uploadLocationIdinteger (optional)
facetsstring (optional)
searchExpressionstring (optional)
workflowDocumentIdinteger (optional)
linkedTaskDocumentIdinteger (optional)
assetTypeIdinteger (optional)
attachmentTypeIdinteger (optional)
initialVersionIdinteger (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
taskDocumentIdstringYesThe task-document's integer ID.
versionIdstringYesThe document version's integer ID to delete.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
taskIdinteger
taskDocumentIdinteger
versionIdinteger
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.


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:

ParameterTypeRequiredDescription
attachIdstringYesThe attachment's integer ID.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
totalRecordsinteger
itemsarray of ReviewRequiredDocumentItem
items[].taskIdinteger (optional)
items[].documentIdinteger (optional)
items[].titlestring (optional)
items[].categorystring (optional)
items[].categoryIdinteger (optional)
items[].assetIdinteger (optional)
items[].attachmentIdinteger (optional)
items[].versionIdinteger (optional)
items[].fileTypeIdinteger (optional)
items[].uploadTypeIdinteger (optional)
items[].instructionsstring (optional)
items[].documentsRequiredTypeinteger (optional)
items[].allowVersionIdinteger (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
taskIdstringYesThe review task's integer ID.
documentIdstringYesThe document's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
titlestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
taskTypeIdinteger (optional)
supportingarray of TaskDocumentHrefItem
supporting[].hrefstring (optional)
supporting[].contentTypestring (optional)
workingarray of TaskDocumentHrefItem
working[].hrefstring (optional)
working[].contentTypestring (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
taskTypeIdinteger (optional)
supportingarray of TaskDocumentHrefItem
supporting[].hrefstring (optional)
supporting[].contentTypestring (optional)
workingarray of TaskDocumentHrefItem
working[].hrefstring (optional)
working[].contentTypestring (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
taskDocumentIdstringYesThe task-document's integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
taskIdinteger
documentIdinteger (optional)
titlestring (optional)
categorystring (optional)
categoryIdinteger (optional)
assetIdinteger (optional)
attachmentIdinteger (optional)
versionIdinteger (optional)
fileTypeIdinteger (optional)
uploadTypeIdinteger (optional)
instructionsstring (optional)
documentsRequiredTypeinteger (optional)
allowVersionIdinteger (optional)
uploadLocationIdinteger (optional)
facetsstring (optional)
searchExpressionstring (optional)
workflowDocumentIdinteger (optional)
linkedTaskDocumentIdinteger (optional)
assetTypeIdinteger (optional)
attachmentTypeIdinteger (optional)
initialVersionIdinteger (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
taskDocumentIdstringYesThe task-document's integer ID.
versionIdstringYesThe document version's integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
documentIdinteger
versionIdinteger
canUndoLatestUploadboolean
canUndoLatestUploadForTipModifierboolean
uploadedByCurrentUserboolean
currentTaskVersionIdinteger
isNewerVersionboolean

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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
taskDocumentIdstringYesThe task-document's integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
totalRecordsinteger
itemsarray of DocumentVersionProjection
items[].versionIdinteger
items[].isDefaultVersionboolean
items[].hasXfdfAnnotationsboolean
items[].isEligibleForDamContentboolean

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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
taskTypeIdinteger (optional)
supportingarray of TaskDocumentHrefItem
supporting[].hrefstring (optional)
supporting[].contentTypestring (optional)
workingarray of TaskDocumentHrefItem
working[].hrefstring (optional)
working[].contentTypestring (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
documentIdstringYesThe document's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
titlestring (optional)
rawobject (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
documentIdstringYesThe document's integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
taskIdinteger
documentIdinteger (optional)
titlestring (optional)
categorystring (optional)
assetIdinteger (optional)
attachmentIdinteger (optional)
versionIdinteger (optional)
fileTypeIdinteger (optional)
uploadTypeIdinteger (optional)
instructionsstring (optional)
documentsRequiredTypeinteger (optional)
allowVersionIdinteger (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:

ParameterTypeRequiredDescription
taskIdstringYesThe review task's integer ID.

Returns:

FieldTypeDescription
totalRecordsinteger
itemsarray of SupportingAttachmentProjection
items[].idstring (optional)
items[].titlestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
totalRecordsinteger
itemsarray of TaskDocumentUploadProjection
items[].taskIdinteger
items[].documentIdinteger (optional)
items[].titlestring (optional)
items[].categorystring (optional)
items[].categoryIdinteger (optional)
items[].assetIdinteger (optional)
items[].attachmentIdinteger (optional)
items[].versionIdinteger (optional)
items[].fileTypeIdinteger (optional)
items[].uploadTypeIdinteger (optional)
items[].instructionsstring (optional)
items[].documentsRequiredTypeinteger (optional)
items[].allowVersionIdinteger (optional)
items[].uploadLocationIdinteger (optional)
items[].facetsstring (optional)
items[].searchExpressionstring (optional)
items[].workflowDocumentIdinteger (optional)
items[].linkedTaskDocumentIdinteger (optional)
items[].assetTypeIdinteger (optional)
items[].attachmentTypeIdinteger (optional)
items[].initialVersionIdinteger (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.

Returns:

FieldTypeDescription
totalRecordsinteger
itemsarray of SupportingAttachmentProjection
items[].idstring (optional)
items[].titlestring (optional)
items[].rawobject (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:

ParameterTypeRequiredDescription
taskIdstringYesThe task's (or review task's) integer ID.
isReviewTaskbooleanNoWhen true, use the review-task route (/review-tasks/{taskId}/...) instead of the plain task route. Default false.

Returns:

FieldTypeDescription
totalRecordsinteger
itemsarray of WorkingDocumentProjection
items[].taskIdinteger
items[].documentIdinteger (optional)
items[].titlestring (optional)
items[].categorystring (optional)
items[].assetIdinteger (optional)
items[].attachmentIdinteger (optional)
items[].versionIdinteger (optional)
items[].fileTypeIdinteger (optional)
items[].uploadTypeIdinteger (optional)
items[].instructionsstring (optional)
items[].documentsRequiredTypeinteger (optional)
items[].allowVersionIdinteger (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:

ParameterTypeRequiredDescription
taskDocIdstringYesThe task-document's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). PM's schema declares this opaque.
confirmedbooleanNoMust 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:

FieldTypeDescription
taskDocIdstring (optional)
rawobject (optional)