Skip to main content

Task Management

Work tasks from assignment to approval: task details and assignments, checklists and data collection forms, task documents, reviews, annotations, supporting documents, and chatboards.

This area has 8 groups and 115 tools, 68 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
View Task Details & AssignmentsRead-onlyLook Up PM Users, Groups & Roles14
Work My TasksCan change dataView Task Details & Assignments, Look Up PM Users, Groups & Roles12
Fill Out Task Checklists & Data Collection FormsCan change dataView Task Details & Assignments, Look Up PM Reference Data10
Attach Documents & Files to TasksCan change dataView Task Details & Assignments, Find & Discover Content17
Review & Approve DeliverablesCan change dataAttach Documents & Files to Tasks, Look Up PM Users, Groups & Roles22
Annotate PM DocumentsCan change dataManage Supporting Documents4
Manage Supporting DocumentsCan change dataView Projects, View Task Details & Assignments, Look Up PM Users, Groups & Roles, Find & Discover Content22
Collaborate in ChatboardsCan change dataLook Up PM Users, Groups & Roles14

View Task Details & Assignments​

Read-only · 14 tools (12 currently available) · Group ID view-task-details-assignments

Needs: Look Up PM Users, Groups & Roles

ToolWhat it does
get_project_tasksLists the tasks that belong to a Project, by the project's integer ID, in Aprimo Marketing Operations.
get_taskReturns a single task (workflow assignment) by its integer ID from Aprimo Marketing Operations.
get_task_assigneeReturns the current user's assignment record for the specified (non-review) task, by the task's integer ID, in Aprimo Marketing Operations.
get_task_assignee_time_detailReturns the time-detail record for the task assignee, by its integer ID, in Aprimo Marketing Operations.
get_task_assigneesReturns the assignee records for a task, by the task's integer ID, in Aprimo Marketing Operations.
get_task_linkNot currently available. Returns a single task link belonging to the specified (non-review) assignment task, in Aprimo Marketing Operations.
get_task_time_entryReturns a single workflow task time entry by its integer ID in Aprimo Marketing Operations.
get_teamReturns a single workflow team by its integer ID in Aprimo Marketing Operations, including its members.
list_task_delegation_usersNot currently available. Returns a paged list of users to whom the specified (non-review) assignment task can be delegated, by the task's integer ID, in Aprimo Marketing Operations.
list_task_linksLists the task links on a (non-review) assignment task, by the task's integer ID, in Aprimo Marketing Operations.
list_tasksLists tasks (workflow assignments) in Aprimo Marketing Operations, paged and unfiltered.
list_teamsLists workflow teams in Aprimo Marketing Operations, paged, with an optional title filter.
search_task_time_entriesSearches workflow task time entries in Aprimo Marketing Operations with a JSON query body, paged and sortable.
search_tasksSearches tasks (workflow assignments) in Aprimo Marketing Operations.

get_project_tasks​

Lists the tasks that belong to a Project, by the project's integer ID, in Aprimo Marketing Operations. Optionally excludes auto-close tasks. Returns totals and human-readable labels for status and users, plus the linked Activity.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes and deep-link bullets.

Parameters:

ParameterTypeRequiredDescription
projectIdstringYesThe parent project'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 (e.g. 'ModifiedDate', 'Name'). Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.
excludeAutoClosebooleanNoWhen true, omit auto-close tasks. Default false (include all).

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of TaskProjectionThe items returned in this response.
items[].taskIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].statusIdinteger (optional)
items[].statusLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].estimatedDurationinteger (optional)
items[].projectIdinteger
items[].projectTitlestring (optional)
items[].projectDeepLinkstring (optional)
items[].activityIdinteger (optional)
items[].activityNamestring (optional)
items[].activityDeepLinkstring (optional)
items[].modifiedByIdinteger (optional)
items[].modifiedByNamestring (optional)
items[].completedByIdinteger (optional)
items[].completedByNamestring (optional)
items[].canCloseboolean (optional)/// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of .
items[].canDelegateboolean (optional)Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
items[].canDeclineboolean (optional)Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
items[].daysOverDueinteger (optional)/// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field.

get_task​

Returns a single task (workflow assignment) by its integer ID from Aprimo Marketing Operations. A task belongs to a Project, which belongs to an Activity. Returns only the base task record itself — not any task sub-resource (assignees, checklists, DCTs, documents, links, review materials, time entries, attachments, etc.), each of which has its own get_task_* tool. Resolves status, modified-by and completed-by user names, and surfaces the linked Project and Activity with deep links. Also reports whether the task can currently be closed, declined, or delegated.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim, including every (id: N) suffix.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.

Returns:

FieldTypeDescription
taskIdinteger
titlestring (optional)
descriptionstring (optional)
statusIdinteger (optional)
statusLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
estimatedDurationinteger (optional)
projectIdinteger
projectTitlestring (optional)
projectDeepLinkstring (optional)
activityIdinteger (optional)
activityNamestring (optional)
activityDeepLinkstring (optional)
modifiedByIdinteger (optional)
modifiedByNamestring (optional)
completedByIdinteger (optional)
completedByNamestring (optional)
canCloseboolean (optional)/// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of .
canDelegateboolean (optional)Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
canDeclineboolean (optional)Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
daysOverDueinteger (optional)/// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field.

get_task_assignee​

Returns the current user's assignment record for the specified (non-review) task, by the task's integer ID, in Aprimo Marketing Operations. Not its time detail (use get_task_assignee_time_detail for that).

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
rawobject (optional)

get_task_assignee_time_detail​

Returns the time-detail record for the task assignee, by its integer ID, in Aprimo Marketing Operations.

Parameters:

ParameterTypeRequiredDescription
idstringYesThe task assignee time-detail record's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
rawobject (optional)The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted field above.

get_task_assignees​

Returns the assignee records for a task, by the task's integer ID, in Aprimo Marketing Operations. Resolves assignee user names.

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 TaskAssigneeItemProjection
items[].assigneeIdinteger
items[].taskIdinteger
items[].userIdinteger (optional)
items[].userNamestring (optional)
items[].workStatusinteger
items[].canCloseboolean
items[].voteResultinteger (optional)
items[].commentsstring (optional)
items[].assignedDatestring (optional)
items[].completedDatestring (optional)
items[].actualBeginDatestring (optional)
items[].actualEndDatestring (optional)
items[].roleIdinteger (optional)
items[].estimatedWorkinteger (optional)Estimated work (in the task's work-unit), newly confirmed by the hardened schema.
items[].actualWorkinteger (optional)Actual work logged so far, newly confirmed by the hardened schema.
items[].sequenceinteger (optional)The assignee's sequence/ordering within the task, newly confirmed by the hardened schema.

Not currently available

Returns a single task link belonging to the specified (non-review) assignment task, in Aprimo Marketing Operations.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
linkIdstringYesThe task link's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above.

get_task_time_entry​

Returns a single workflow task time entry by its integer ID in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
idstringYesThe task time entry's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the defensively-extracted field above.

get_team​

Returns a single workflow team by its integer ID in Aprimo Marketing Operations, including its members. Resolves member user names.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
teamIdstringYesThe team's integer ID.

Returns:

FieldTypeDescription
teamIdinteger
namestring (optional)
descriptionstring (optional)
membersarray of TeamMemberProjection
members[].teamMemberIdinteger
members[].teamIdinteger
members[].roleIdinteger (optional)
members[].userIdinteger (optional)
members[].userNamestring (optional)
members[].hasEditRightboolean (optional)
members[].hasFinancialsEditRightboolean (optional)

list_task_delegation_users​

Not currently available

Returns a paged list of users to whom the specified (non-review) assignment task can be delegated, 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 assignment task's integer ID.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of DelegationUserProjectionThe items returned in this response.
items[].idstring (optional)
items[].namestring (optional)
items[].rawobject (optional)The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above.

Lists the task links on a (non-review) assignment 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 assignment task's integer ID.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of TaskLinkProjectionThe items returned in this response.
items[].idstring (optional)
items[].namestring (optional)
items[].rawobject (optional)The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above.

list_tasks​

Lists tasks (workflow assignments) in Aprimo Marketing Operations, paged and unfiltered. Use search_tasks when you need to filter by name, status, project, or dates; use get_project_tasks to browse the tasks of one Project; use this to browse all tasks. Returns totals and human-readable labels for status and users, plus the linked Project/Activity.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes and deep-link bullets.

Parameters:

ParameterTypeRequiredDescription
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 (e.g. 'ModifiedDate', 'Name'). Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of TaskProjectionThe items returned in this response.
items[].taskIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].statusIdinteger (optional)
items[].statusLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].estimatedDurationinteger (optional)
items[].projectIdinteger
items[].projectTitlestring (optional)
items[].projectDeepLinkstring (optional)
items[].activityIdinteger (optional)
items[].activityNamestring (optional)
items[].activityDeepLinkstring (optional)
items[].modifiedByIdinteger (optional)
items[].modifiedByNamestring (optional)
items[].completedByIdinteger (optional)
items[].completedByNamestring (optional)
items[].canCloseboolean (optional)/// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of .
items[].canDelegateboolean (optional)Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
items[].canDeclineboolean (optional)Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
items[].daysOverDueinteger (optional)/// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field.

list_teams​

Lists workflow teams in Aprimo Marketing Operations, paged, with an optional title filter. Resolves each team's member user names.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
titleFilterstringNoOptional case-insensitive substring filter on the team's title. Omit to match all teams.
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 (default 'Name').
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of TeamProjectionThe items returned in this response.
items[].teamIdinteger
items[].namestring (optional)
items[].descriptionstring (optional)
items[].membersarray of TeamMemberProjection
items[].members[].teamMemberIdinteger
items[].members[].teamIdinteger
items[].members[].roleIdinteger (optional)
items[].members[].userIdinteger (optional)
items[].members[].userNamestring (optional)
items[].members[].hasEditRightboolean (optional)
items[].members[].hasFinancialsEditRightboolean (optional)

search_task_time_entries​

Searches workflow task time entries in Aprimo Marketing Operations with a JSON query body, paged and sortable. No resource is created or changed by this call.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
querystringYesJSON-encoded search body using PM's operator-tree DSL -- not a flat {field: value} object. This route has no OpenAPI schema (see this class's remarks), but it shares the same underlying search engine as search_projects/search_activities, and its valid fields are confirmed from the api repo's WfTaskTimeEntriesEntity model (api repo, 2026-08-17). The body must have exactly one top-level operator. Operators (all lowercase, no separators): 'equals', 'contains', 'lessthan', 'lessthanorequalto', 'greaterthan', 'greaterthanorequalto', 'isnull', 'isnotnull', 'and', 'or', 'not'. Leaf operators take {FieldName, FieldValue} (pascal case) where FieldName is one of the 7 valid fields -- 'TimeEntryId' (int), 'AssigneeId' (int), 'ActualDate' (ISO 8601 date), 'ActualWork' (int), 'Comments' (string), 'EnteredActualWorkHours' (int), 'EnteredActualWorkMinutes' (int) -- and FieldValue is a native JSON value matching that type. No other field names are valid; there is no Extended Attributes support for this entity. Composite 'and'/'or' take an array of operations; 'not' takes a single operation object. Examples: by assignee '{"equals":{"FieldName":"AssigneeId","FieldValue":12345}}'; by date '{"equals":{"FieldName":"ActualDate","FieldValue":"2026-08-01"}}'. Pass "{}" for an unfiltered search.
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
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of WfTaskTimeEntryProjectionThe items returned in this response.
items[].idstring (optional)
items[].rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the defensively-extracted field above.

search_tasks​

Searches tasks (workflow assignments) in Aprimo Marketing Operations. A task belongs to a Project, which belongs to an Activity. Returns a paged list with totals and human-readable labels for status and users, plus the linked Project/Activity with deep links. Use get_project_tasks to list the tasks of one Project; use this to query across tasks.

Response format. Items come back as pre-rendered markdown blocks intended for verbatim display, each carrying an (id: N) suffix and a deep-link bullet, with every item rendered separately.

Filtering. Prefer the name-keyed statusLabel parameter over composing the query DSL.

Query DSL. query takes a structured operator tree using PascalCase FieldName/FieldValue. By partial name: query='{"contains":{"FieldName":"Name","FieldValue":"review"}}'. By project: query='{"equals":{"FieldName":"ProjectId","FieldValue":67890}}'. To browse without a filter use list_tasks instead — an empty query='{}' is rejected.

Parameters:

ParameterTypeRequiredDescription
querystringYesJSON-encoded search body using PM's operator-tree DSL — not a flat {field: value} object. Exactly one top-level operator. Operators (all lowercase): 'equals', 'contains', 'lessthan', 'lessthanorequalto', 'greaterthan', 'greaterthanorequalto', 'isnull', 'isnotnull', 'and', 'or', 'not'. Leaf operators take {FieldName, FieldValue} (pascal case) where FieldName is PM's wire field name ('TaskId', 'Name', 'ProjectId', 'ActivityId', 'WorkFlowTaskStatus', 'BeginDate', 'EndDate', etc.) and FieldValue is a native JSON value matching the field's type. Composite 'and'/'or' take an array of operations; 'not' takes a single operation object. PM rejects an empty '{}' (throws 'Couldn't find any operator') — it is not a match-all query; use list_tasks to browse without a filter. For status filtering, prefer the statusLabel parameter below.
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 (e.g. 'ModifiedDate', 'Name'). Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.
statusLabelstringNoFilter to tasks with this status (label, case-insensitive). Resolved against the PM task status lookup (WorkFlowTaskStatus). Returns an error if the label doesn't match any known status. Combined with query via and.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of TaskProjectionThe items returned in this response.
items[].taskIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].statusIdinteger (optional)
items[].statusLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].estimatedDurationinteger (optional)
items[].projectIdinteger
items[].projectTitlestring (optional)
items[].projectDeepLinkstring (optional)
items[].activityIdinteger (optional)
items[].activityNamestring (optional)
items[].activityDeepLinkstring (optional)
items[].modifiedByIdinteger (optional)
items[].modifiedByNamestring (optional)
items[].completedByIdinteger (optional)
items[].completedByNamestring (optional)
items[].canCloseboolean (optional)/// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of .
items[].canDelegateboolean (optional)Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
items[].canDeclineboolean (optional)Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
items[].daysOverDueinteger (optional)/// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field.

Work My Tasks​

Can change data · 12 tools (9 currently available) · Group ID work-my-tasks

Needs: View Task Details & Assignments, Look Up PM Users, Groups & Roles

ToolWhat it does
accept_taskAccepts a task assignment, by the task's integer ID, in Aprimo Marketing Operations.
close_taskNot currently available. Destructive. Closes a task (workflow assignment) in Aprimo Marketing Operations.
decline_taskDestructive. Declines a task (workflow assignment) in Aprimo Marketing Operations.
delegate_taskNot currently available. Destructive. Delegates a task (workflow assignment) to another user in Aprimo Marketing Operations.
update_taskUpdates an existing task (workflow assignment) by its integer ID in Aprimo Marketing Operations.
update_task_assigneeNot currently available. Updates the current user's assignment record on the specified task (for example, the time and work details from the work-entry panel), in Aprimo Marketing Operations.
update_task_assignee_time_detailUpdates the task assignee's time-detail record, by its integer ID, in Aprimo Marketing Operations.
update_task_begin_dateUpdates the begin date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations.
update_task_end_dateUpdates the end date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations.
update_task_estimated_durationUpdates the estimated duration of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations.
validate_task_assigneeValidates whether the current user's work on the specified task can be closed, in Aprimo Marketing Operations.
validate_task_assignee_time_detailValidates the supplied time-detail data for a task assignee without persisting any changes, by the record's integer ID, in Aprimo Marketing Operations.

accept_task​

Accepts a task assignment, by the task's integer ID, in Aprimo Marketing Operations. This is an additive commitment (the assignee agrees to take on the task) — not a state-ending action. Requires confirmed=true after confirming the exact task with the user. Returns the accept action's result.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID to accept.
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.

Returns:

FieldTypeDescription
actionIdstring (optional)
taskIdinteger
assigneeIdinteger
statusinteger
messagestring (optional)

close_task​

Destructive · Not currently available

Closes a task (workflow assignment) in Aprimo Marketing Operations. This is a state change that completes the task and advances the workflow. Optionally promotes the task's annotations on close. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact task with the user.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID to close.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — closing a task changes its state and drives the workflow. Set only after stating the exact task to the user and getting explicit go-ahead.
promoteAnnotationsbooleanNoWhen true, promote the task's annotations on close. Default false.

Returns:

FieldTypeDescription
taskIdinteger
actionstring (optional)The state-change action performed: "close", "decline", or "delegate".
succeededboolean
delegatedToUserIdinteger (optional)For delegate_task only: the user the task was delegated to.
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.


decline_task​

Destructive

Declines a task (workflow assignment) in Aprimo Marketing Operations. This is a state change that rejects the assignment. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact task with the user.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID to decline.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — declining a task changes its state. Set only after stating the exact task to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
taskIdinteger
actionstring (optional)The state-change action performed: "close", "decline", or "delegate".
succeededboolean
delegatedToUserIdinteger (optional)For delegate_task only: the user the task was delegated to.
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.


delegate_task​

Destructive · Not currently available

Delegates a task (workflow assignment) to another user in Aprimo Marketing Operations. This is a state change that reassigns the task. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact task and target user with the user. Returns a 409-style conflict message if the task cannot be delegated in its current state.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID to delegate.
taskAssigneeIdstringYesThe task assignee record's integer ID (the assignment being delegated).
newUserIdstringYesThe integer user ID to delegate the task to.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — delegating a task reassigns it and changes its state. Set only after stating the exact task and target user to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
taskIdinteger
actionstring (optional)The state-change action performed: "close", "decline", or "delegate".
succeededboolean
delegatedToUserIdinteger (optional)For delegate_task only: the user the task was delegated to.
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.


update_task​

Updates an existing task (workflow assignment) by its integer ID in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). To change a task's begin date, end date, or estimated duration, prefer the dedicated tools (update_task_begin_date / update_task_end_date / update_task_estimated_duration) — those fields are read-only on this endpoint. Requires confirmed=true after showing the user the exact changes. Returns the updated task. Note: PM's response-building step for this endpoint can fail after the write has already been committed (e.g. a pre-existing unrelated date field it can't reserialize) — if this happens, the error message includes the task's just-re-fetched current state so you can confirm whether the change actually applied before retrying, rather than assuming the update was rejected outright.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
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
taskIdinteger
titlestring (optional)
descriptionstring (optional)
statusIdinteger (optional)
statusLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
estimatedDurationinteger (optional)
projectIdinteger
projectTitlestring (optional)
projectDeepLinkstring (optional)
activityIdinteger (optional)
activityNamestring (optional)
activityDeepLinkstring (optional)
modifiedByIdinteger (optional)
modifiedByNamestring (optional)
completedByIdinteger (optional)
completedByNamestring (optional)
canCloseboolean (optional)/// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of .
canDelegateboolean (optional)Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
canDeclineboolean (optional)Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
daysOverDueinteger (optional)/// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field.

update_task_assignee​

Not currently available

Updates the current user's assignment record on the specified task (for example, the time and work details from the work-entry panel), in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the updated record.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
bodystringYesJSON object with the assignment record fields to update (PM wire names).
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
idstring (optional)
rawobject (optional)

update_task_assignee_time_detail​

Updates the task assignee's time-detail record, by its integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the updated record.

Parameters:

ParameterTypeRequiredDescription
idstringYesThe task assignee time-detail record's integer ID.
bodystringYesJSON object with the time-detail fields to update (PM wire names). Confirmed shape (from the Marketing Operations UI's own request body, cross-checked against a working Postman capture -- this cluster has no OpenAPI schema, see this class's remarks): a top-level assigneeId plus a taskTimeEntries array, where each entry has timeEntryId, actualDate (ISO 8601), enteredActualWorkHours, enteredActualWorkMinutes, comments, and its own assigneeId. Example: {"assigneeId": 101, "taskTimeEntries": [{"timeEntryId": 1001, "assigneeId": 101, "actualDate": "2026-08-17", "enteredActualWorkHours": 2, "enteredActualWorkMinutes": 30, "comments": "Worked on review."}]}. A shorthand guess like {"hours": 3} will not match this shape and will fail or be silently ignored.
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
idstring (optional)
rawobject (optional)The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted field above.

update_task_begin_date​

Updates the begin date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact new begin date. Returns the updated task.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
bodystringYesJSON object carrying the new begin date in PM wire form (e.g. {"beginDate":"2026-08-01T00:00:00Z"}).
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
taskIdinteger
titlestring (optional)
descriptionstring (optional)
statusIdinteger (optional)
statusLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
estimatedDurationinteger (optional)
projectIdinteger
projectTitlestring (optional)
projectDeepLinkstring (optional)
activityIdinteger (optional)
activityNamestring (optional)
activityDeepLinkstring (optional)
modifiedByIdinteger (optional)
modifiedByNamestring (optional)
completedByIdinteger (optional)
completedByNamestring (optional)
canCloseboolean (optional)/// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of .
canDelegateboolean (optional)Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
canDeclineboolean (optional)Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
daysOverDueinteger (optional)/// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field.

update_task_end_date​

Updates the end date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact new end date. Returns the updated task.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
bodystringYesJSON object carrying the new end date in PM wire form (e.g. {"endDate":"2026-08-15T00:00:00Z"}).
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
taskIdinteger
titlestring (optional)
descriptionstring (optional)
statusIdinteger (optional)
statusLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
estimatedDurationinteger (optional)
projectIdinteger
projectTitlestring (optional)
projectDeepLinkstring (optional)
activityIdinteger (optional)
activityNamestring (optional)
activityDeepLinkstring (optional)
modifiedByIdinteger (optional)
modifiedByNamestring (optional)
completedByIdinteger (optional)
completedByNamestring (optional)
canCloseboolean (optional)/// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of .
canDelegateboolean (optional)Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
canDeclineboolean (optional)Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
daysOverDueinteger (optional)/// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field.

update_task_estimated_duration​

Updates the estimated duration of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact new estimated duration. Returns the updated task.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
bodystringYesJSON object carrying the new estimated duration in PM wire form (e.g. {"estimatedDuration":480}).
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
taskIdinteger
titlestring (optional)
descriptionstring (optional)
statusIdinteger (optional)
statusLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
estimatedDurationinteger (optional)
projectIdinteger
projectTitlestring (optional)
projectDeepLinkstring (optional)
activityIdinteger (optional)
activityNamestring (optional)
activityDeepLinkstring (optional)
modifiedByIdinteger (optional)
modifiedByNamestring (optional)
completedByIdinteger (optional)
completedByNamestring (optional)
canCloseboolean (optional)/// Whether the task can currently be closed (drives whether close_task is applicable). PM's schema declares this a YesNo integer (not a real boolean) -- kept as a defensive, tolerant read (see ), not part of .
canDelegateboolean (optional)Whether the task can currently be delegated (drives whether delegate_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
canDeclineboolean (optional)Whether the task can currently be declined (drives whether decline_task is applicable). A real boolean on the wire (WfTask shape only -- absent on WfProjectTask).
daysOverDueinteger (optional)/// Number of days the task is overdue. Only populated by the WfProjectTask shape (get_project_tasks/get_task_calendar) -- null for WfTask/AssignmentTask reads (get_task/list_tasks/search_tasks), which don't carry this field.

validate_task_assignee​

Validates whether the current user's work on the specified task can be closed, 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.

Returns:

FieldTypeDescription
rawobject (optional)

validate_task_assignee_time_detail​

Validates the supplied time-detail data for a task assignee without persisting any changes, by the record's integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
idstringYesThe task assignee time-detail record's integer ID.
bodystringYesJSON object with the time-detail data to validate (PM wire names).

Returns:

FieldTypeDescription
rawobject (optional)

Fill Out Task Checklists & Data Collection Forms​

Can change data · 10 tools (2 currently available) · Group ID fill-out-task-checklists-data-collection-forms

Needs: View Task Details & Assignments, Look Up PM Reference Data

ToolWhat it does
get_task_checklistNot currently available. Returns a single checklist, including its checklist items, for an assignment task in Aprimo Marketing Operations.
get_task_checklist_resultsNot currently available. Returns the saved results for a checklist on a task assignment, in Aprimo Marketing Operations.
get_task_dctNot currently available. Returns a single data collection template (DCT) for an assignment task, including whether the current user can save it, in Aprimo Marketing Operations.
get_task_dct_resultsNot currently available. Returns the saved data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations.
list_task_checklistsLists the checklists on an assignment task, by the task's integer ID, in Aprimo Marketing Operations.
list_task_dctsLists the data collection templates (DCTs) associated with an assignment task, by the task's integer ID, in Aprimo Marketing Operations.
update_task_checklist_resultsNot currently available. Saves the submitted results for a checklist on a task assignment, in Aprimo Marketing Operations.
update_task_dct_resultsNot currently available. Saves data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations.
validate_task_checklist_resultsNot currently available. Validates a checklist's results to determine whether the task can be closed, in Aprimo Marketing Operations.
validate_task_dct_resultsNot currently available. Validates a task assignment's data collection template (DCT) results to determine whether they meet the requirements for closing the task, in Aprimo Marketing Operations.

get_task_checklist​

Not currently available

Returns a single checklist, including its checklist items, for an assignment task in Aprimo Marketing Operations. Not its results (use get_task_checklist_results for those).

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
checklistIdstringYesThe checklist's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)The complete wire object, verbatim -- including nested checklist items, whose real shape is not part of this schema-blind cluster (see class remarks) -- for full fidelity beyond the defensively-extracted fields above.

get_task_checklist_results​

Not currently available

Returns the saved results for a checklist on a task assignment, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
checklistIdstringYesThe checklist's integer ID.

Returns:

FieldTypeDescription
countinteger (optional)
rawobject (optional)

get_task_dct​

Not currently available

Returns a single data collection template (DCT) for an assignment task, including whether the current user can save it, in Aprimo Marketing Operations. Not its results (use get_task_dct_results for those).

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
dctIdstringYesThe DCT's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)The complete wire object, verbatim -- including the unverified "can save" indicator noted in this class's remarks -- for full fidelity beyond the defensively-extracted fields above.

get_task_dct_results​

Not currently available

Returns the saved data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
dctIdstringYesThe DCT's integer ID.

Returns:

FieldTypeDescription
countinteger (optional)
rawobject (optional)

list_task_checklists​

Lists the checklists on an assignment task, by the task's integer ID, in Aprimo Marketing Operations. Limited to the checklists the current user is allowed to see.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of TaskChecklistProjectionThe items returned in this response.
items[].idstring (optional)
items[].namestring (optional)
items[].rawobject (optional)The complete wire object, verbatim -- including nested checklist items, whose real shape is not part of this schema-blind cluster (see class remarks) -- for full fidelity beyond the defensively-extracted fields above.

list_task_dcts​

Lists the data collection templates (DCTs) associated with an assignment 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 assignment task's integer ID.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of TaskDctProjectionThe items returned in this response.
items[].idstring (optional)
items[].namestring (optional)
items[].rawobject (optional)The complete wire object, verbatim -- including the unverified "can save" indicator noted in this class's remarks -- for full fidelity beyond the defensively-extracted fields above.

update_task_checklist_results​

Not currently available

Saves the submitted results for a checklist on a task assignment, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the saved results.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
checklistIdstringYesThe checklist's integer ID.
bodystringYesJSON object with the checklist results to save (PM wire names).
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
countinteger (optional)
rawobject (optional)

update_task_dct_results​

Not currently available

Saves data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the saved results.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
dctIdstringYesThe DCT's integer ID.
bodystringYesJSON object with the DCT result values to save (PM wire names).
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
countinteger (optional)
rawobject (optional)

validate_task_checklist_results​

Not currently available

Validates a checklist's results to determine whether the task can be closed, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
checklistIdstringYesThe checklist's integer ID.

Returns:

FieldTypeDescription
countinteger (optional)
rawobject (optional)

validate_task_dct_results​

Not currently available

Validates a task assignment's data collection template (DCT) results to determine whether they meet the requirements for closing the task, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe assignment task's integer ID.
dctIdstringYesThe DCT's integer ID.

Returns:

FieldTypeDescription
countinteger (optional)
rawobject (optional)

Attach Documents & Files to Tasks​

Can change data · 17 tools (5 currently available) · Group ID attach-documents-files-to-tasks

Needs: View Task Details & Assignments, Find & Discover Content

ToolWhat it does
associate_uploaded_document_with_taskNot currently available. Associates an uploaded document version with a task's document-upload instruction, in Aprimo Marketing Operations.
create_task_document_attachmentNot currently available. Creates an attachment for a task document, by task ID and task-document ID, in Aprimo Marketing Operations.
create_task_document_attachment_versionNot currently available. 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_uploadNot currently available. Creates a task document-upload requirement for a task, in Aprimo Marketing Operations.
delete_task_document_uploaded_versionNot currently available. Destructive. Permanently deletes an uploaded task document version, by task ID, task-document ID, and version ID, in Aprimo Marketing Operations.
get_task_document_assetsNot currently available. 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_attachmentsNot currently available. 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_uploadReturns a single task document-upload requirement by task ID and task-document ID, in Aprimo Marketing Operations.
get_task_document_uploaded_versionNot currently available. 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_versionsNot currently available. Lists the uploaded versions of a task document, by task ID and task-document ID, in Aprimo Marketing Operations.
get_task_documentsNot currently available. Returns the documents (supporting + working, grouped by task type) for a task, in Aprimo Marketing Operations.
get_task_supporting_attachmentReturns a single supporting (reference/background) attachment for a (non-review) task, by task ID and document ID, in Aprimo Marketing Operations.
get_task_working_attachmentNot currently available. Returns a single working attachment document for a task, by task ID and document ID, in Aprimo Marketing Operations.
list_task_document_uploadsLists the document-upload requirements for a task, in Aprimo Marketing Operations.
list_task_supporting_attachmentsLists supporting (reference/background) attachments for a (non-review) task, by the task's integer ID, in Aprimo Marketing Operations.
list_task_working_attachmentsLists all working attachment documents for a task, in Aprimo Marketing Operations.
update_assignment_documentNot currently available. 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​

Not currently available

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​

Not currently available

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​

Not currently available

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​

Not currently available

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​

Destructive · Not currently available

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_task_document_assets​

Not currently available

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​

Not currently available

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​

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​

Not currently available

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​

Not currently available

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​

Not currently available

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​

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​

Not currently available

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_task_document_uploads​

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​

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​

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​

Not currently available

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)

Review & Approve Deliverables​

Can change data · 22 tools (10 currently available) · Group ID review-approve-deliverables

Needs: Attach Documents & Files to Tasks, Look Up PM Users, Groups & Roles

ToolWhat it does
cast_review_task_voteNot currently available. Destructive. Casts a vote on a review task in Aprimo Marketing Operations.
delegate_review_taskNot currently available. Destructive. Delegates a review task to another user in Aprimo Marketing Operations.
get_review_document_vote_commentsNot currently available. Returns the assignees' vote comments for one document under document-level voting (DLV), by task ID and task-document ID, in Aprimo Marketing Operations.
get_review_required_documentsReturns all tasks that a given attachment is required on (paged), by the attachment's integer ID, in Aprimo Marketing Operations.
get_review_taskReturns a single review task by its integer ID in Aprimo Marketing Operations.
get_review_task_assigneeNot currently available. Returns the current user's assignment record for the specified review task, by the review task's integer ID, in Aprimo Marketing Operations.
get_review_task_linkNot currently available. Returns a single task link belonging to the specified review task, in Aprimo Marketing Operations.
get_review_task_review_materialsNot currently available. Returns the review materials (document hrefs) for a review task, by the review task's integer ID, in Aprimo Marketing Operations.
get_review_task_supporting_attachmentNot currently available. 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_votesReturns the document-level vote records for a task under document-level voting (DLV), by the task's integer ID, in Aprimo Marketing Operations.
get_task_review_materialsReturns the review materials (document hrefs) for a task, by the task's integer ID, in Aprimo Marketing Operations.
list_my_review_tasksLists review tasks assigned to the current user, in Aprimo Marketing Operations, paged.
list_review_task_delegation_usersNot currently available. Returns a paged list of users to whom the specified review task can be delegated, by the review task's integer ID, in Aprimo Marketing Operations.
list_review_task_document_votesNot currently available. Returns the document-level vote records for a review task under document-level voting (DLV), by the review task's integer ID, in Aprimo Marketing Operations.
list_review_task_linksLists the task links on a review task, by the review task's integer ID, in Aprimo Marketing Operations.
list_review_task_supporting_attachmentsLists supporting (reference/background) attachments for a review task, by the review task's integer ID, in Aprimo Marketing Operations.
list_review_tasksLists review tasks in Aprimo Marketing Operations, paged, with optional filters on task status, modified-after date, and task title.
search_review_tasksSearches review tasks in Aprimo Marketing Operations by name, paged.
update_review_task_begin_dateNot currently available. Updates the begin date of a review task by its integer ID in Aprimo Marketing Operations.
update_review_task_document_voteNot currently available. Updates the review vote for a document in a review-material task, by the task-document's integer ID, in Aprimo Marketing Operations.
update_review_task_end_dateNot currently available. Updates the end date of a review task by its integer ID in Aprimo Marketing Operations.
update_review_task_estimated_durationUpdates the estimated duration of a review task by its integer ID in Aprimo Marketing Operations.

cast_review_task_vote​

Destructive · Not currently available

Casts a vote on a review task in Aprimo Marketing Operations. This is a state change that records the assignee's vote (approve/reject/etc.) and may advance the workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact review task and vote with the user.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID.
voteResultintegerYesThe integer vote result to cast (PM's ReviewTaskVoteResult enum, e.g. approve/reject).
commentsstringNoOptional comments on the vote.
daysintegerNoOptional days spent reviewing.
hoursintegerNoOptional hours spent reviewing.
minutesintegerNoOptional minutes spent reviewing.
rejectReasonIdintegerNoOptional integer ID of the reason for rejecting, when voteResult is a rejection.
electronicSignaturestringNoOptional electronic signature text, when the review task requires one.
promoteAttachmentsbooleanNoWhen true, promote the task's draft attachments on vote. Default false.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — casting a vote changes the review task's state. Set only after stating the exact review task and vote to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
taskIdinteger
successboolean
messagestring (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.


delegate_review_task​

Destructive · Not currently available

Delegates a review task to another user in Aprimo Marketing Operations. This is a state change that reassigns the review task. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact review task and target user with the user. Returns a 409-style conflict message if the review task cannot be delegated in its current state.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID to delegate.
taskAssigneeIdstringYesThe task assignee record's integer ID (the assignment being delegated).
newUserIdstringYesThe integer user ID to delegate the review task to.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — delegating a review task reassigns it and changes its state. Set only after stating the exact review task and target user to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
taskIdinteger
successboolean
failedDueToConflictingDataboolean
messagestring (optional)
messageResourceIdstring (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.


get_review_document_vote_comments​

Not currently available

Returns the assignees' vote comments for one document under document-level voting (DLV), by task ID and task-document ID, in Aprimo Marketing Operations. Resolves related-user names.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.
taskDocIdstringYesThe task-document's integer ID.

Returns:

FieldTypeDescription
readOnlyboolean
totalRecordsinteger
itemsarray of ReviewTaskDocumentVoteProjection
items[].taskNamestring (optional)
items[].taskIdinteger (optional)
items[].workflowStepIdinteger (optional)
items[].taskDocIdinteger
items[].assigneeIdinteger
items[].versionIdinteger
items[].voteResultinteger (optional)
items[].rejectIdinteger (optional)
items[].commentsstring (optional)
items[].voteResultEncTitleIdinteger (optional)
items[].relatedUserIdinteger (optional)
items[].relatedUserNamestring (optional)
items[].relatedCompletedDatestring (optional)
items[].relatedNotVotedAssigneeUserIdsarray of integer (optional)

get_review_required_documents​

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​

Returns a single review task by its integer ID in Aprimo Marketing Operations. Not its assignee (get_review_task_assignee), link (get_review_task_link), review materials (get_review_task_review_materials), or supporting attachment (get_review_task_supporting_attachment). Resolves status label and modified/completed-by user names. Also reports whether the review task can currently be closed, delegated, declined, or skipped.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID.

Returns:

FieldTypeDescription
taskIdinteger
projectIdinteger
projectDeepLinkstring (optional)
namestring (optional)
descriptionstring (optional)
statusIdinteger (optional)
statusLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
estimatedDurationinteger (optional)
modifiedByIdinteger (optional)
modifiedByNamestring (optional)
completedByIdinteger (optional)
completedByNamestring (optional)
canCloseboolean (optional)Whether the review task can currently be closed.
canDelegateboolean (optional)Whether the review task can currently be delegated (drives delegate_review_task).
canDeclineboolean (optional)Whether the review task can currently be declined.
canSkipboolean (optional)Whether the review task can currently be skipped.
voteStyleinteger (optional)PM's ReviewTaskVoteStyle enum, as a raw integer -- no existing resolver maps it to a display label.
voteResultinteger (optional)PM's ReviewTaskVoteResult enum, as a raw integer -- no existing resolver maps it to a display label.
documentLevelVotingboolean (optional)
allMustVoteboolean (optional)
requiresElectronicSignatureboolean (optional)
numberOfAssigneesinteger (optional)
rawobject (optional)The complete wire object, verbatim. See the class remarks.

get_review_task_assignee​

Not currently available

Returns the current user's assignment record for the specified review task, by the review task's integer ID, in Aprimo Marketing Operations.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
rawobject (optional)

Not currently available

Returns a single task link belonging to the specified review task, in Aprimo Marketing Operations.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe review task's integer ID.
linkIdstringYesThe task link's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above.

get_review_task_review_materials​

Not currently available

Returns the review materials (document hrefs) for a review task, by the review task's integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID.

Returns:

FieldTypeDescription
reviewMaterialsarray of ReviewMaterialItemProjection
reviewMaterials[].hrefstring (optional)

get_review_task_supporting_attachment​

Not currently available

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_votes​

Returns the document-level vote records for a task under document-level voting (DLV), by the task's integer ID, in Aprimo Marketing Operations. Resolves related-user names.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
taskIdstringYesThe task's integer ID.

Returns:

FieldTypeDescription
readOnlyboolean
totalRecordsinteger
itemsarray of ReviewTaskDocumentVoteProjection
items[].taskNamestring (optional)
items[].taskIdinteger (optional)
items[].workflowStepIdinteger (optional)
items[].taskDocIdinteger
items[].assigneeIdinteger
items[].versionIdinteger
items[].voteResultinteger (optional)
items[].rejectIdinteger (optional)
items[].commentsstring (optional)
items[].voteResultEncTitleIdinteger (optional)
items[].relatedUserIdinteger (optional)
items[].relatedUserNamestring (optional)
items[].relatedCompletedDatestring (optional)
items[].relatedNotVotedAssigneeUserIdsarray of integer (optional)

get_task_review_materials​

Returns the review materials (document hrefs) for a task, by the task's integer 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.

Returns:

FieldTypeDescription
reviewMaterialsarray of ReviewMaterialItemProjection
reviewMaterials[].hrefstring (optional)

list_my_review_tasks​

Lists review tasks assigned to the current user, in Aprimo Marketing Operations, paged. PM's snapshot declares the response shape as opaque, so items are surfaced with best-effort id/name extraction plus the full raw wire object.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ReviewTaskMineItemProjectionThe items returned in this response.
items[].taskIdstring (optional)
items[].namestring (optional)
items[].rawobject (optional)

list_review_task_delegation_users​

Not currently available

Returns a paged list of users to whom the specified review task can be delegated, 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
reviewTaskIdstringYesThe review task's integer ID.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of DelegationUserProjectionThe items returned in this response.
items[].idstring (optional)
items[].namestring (optional)
items[].rawobject (optional)The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above.

list_review_task_document_votes​

Not currently available

Returns the document-level vote records for a review task under document-level voting (DLV), by the review task's integer ID, in Aprimo Marketing Operations. The result is flagged read-only when the current user cannot vote on it. PM's snapshot declares this route's response shape as opaque, so items are surfaced with best-effort id extraction plus the full raw wire object.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID.

Returns:

FieldTypeDescription
readOnlyboolean (optional)
totalRecordsinteger
itemsarray of ReviewTaskDocumentVoteRawItemProjection
items[].taskDocIdstring (optional)
items[].rawobject (optional)

Lists the task links on 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
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of TaskLinkProjectionThe items returned in this response.
items[].idstring (optional)
items[].namestring (optional)
items[].rawobject (optional)The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above.

list_review_task_supporting_attachments​

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_review_tasks​

Lists review tasks in Aprimo Marketing Operations, paged, with optional filters on task status, modified-after date, and task title. Resolves status labels and modified/completed-by user names.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
taskStatusintegerNoOptional integer task-status id to filter by. Omit to match any status.
modifiedAfterDatestringNoOptional ISO-8601 date; only review tasks modified on/after this date are returned.
taskTitlestringNoOptional case-insensitive substring filter on the review task's title.
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 (default 'TaskId').
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ReviewTaskProjectionThe items returned in this response.
items[].taskIdinteger
items[].projectIdinteger
items[].projectDeepLinkstring (optional)
items[].namestring (optional)
items[].descriptionstring (optional)
items[].statusIdinteger (optional)
items[].statusLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].estimatedDurationinteger (optional)
items[].modifiedByIdinteger (optional)
items[].modifiedByNamestring (optional)
items[].completedByIdinteger (optional)
items[].completedByNamestring (optional)
items[].canCloseboolean (optional)Whether the review task can currently be closed.
items[].canDelegateboolean (optional)Whether the review task can currently be delegated (drives delegate_review_task).
items[].canDeclineboolean (optional)Whether the review task can currently be declined.
items[].canSkipboolean (optional)Whether the review task can currently be skipped.
items[].voteStyleinteger (optional)PM's ReviewTaskVoteStyle enum, as a raw integer -- no existing resolver maps it to a display label.
items[].voteResultinteger (optional)PM's ReviewTaskVoteResult enum, as a raw integer -- no existing resolver maps it to a display label.
items[].documentLevelVotingboolean (optional)
items[].allMustVoteboolean (optional)
items[].requiresElectronicSignatureboolean (optional)
items[].numberOfAssigneesinteger (optional)
items[].rawobject (optional)The complete wire object, verbatim. See the class remarks.

search_review_tasks​

Searches review tasks in Aprimo Marketing Operations by name, paged.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
nameFilterstringNoOptional case-insensitive substring filter on the review task's name. Omit to match all review tasks.
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
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ReviewTaskProjectionThe items returned in this response.
items[].taskIdinteger
items[].projectIdinteger
items[].projectDeepLinkstring (optional)
items[].namestring (optional)
items[].descriptionstring (optional)
items[].statusIdinteger (optional)
items[].statusLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].estimatedDurationinteger (optional)
items[].modifiedByIdinteger (optional)
items[].modifiedByNamestring (optional)
items[].completedByIdinteger (optional)
items[].completedByNamestring (optional)
items[].canCloseboolean (optional)Whether the review task can currently be closed.
items[].canDelegateboolean (optional)Whether the review task can currently be delegated (drives delegate_review_task).
items[].canDeclineboolean (optional)Whether the review task can currently be declined.
items[].canSkipboolean (optional)Whether the review task can currently be skipped.
items[].voteStyleinteger (optional)PM's ReviewTaskVoteStyle enum, as a raw integer -- no existing resolver maps it to a display label.
items[].voteResultinteger (optional)PM's ReviewTaskVoteResult enum, as a raw integer -- no existing resolver maps it to a display label.
items[].documentLevelVotingboolean (optional)
items[].allMustVoteboolean (optional)
items[].requiresElectronicSignatureboolean (optional)
items[].numberOfAssigneesinteger (optional)
items[].rawobject (optional)The complete wire object, verbatim. See the class remarks.

update_review_task_begin_date​

Not currently available

Updates the begin date of a review task by its integer ID in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. {"beginDate":"2026-08-01T00:00:00Z"}). Requires confirmed=true after showing the user the exact new begin date. Returns the updated task.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID.
bodystringYesJSON object carrying the new begin date in PM wire form. 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
taskIdinteger (optional)
rawobject (optional)

update_review_task_document_vote​

Not currently available

Updates the review vote for a document in a review-material task, 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 (e.g. vote result/comments). Requires confirmed=true after showing the user the exact payload.

Parameters:

ParameterTypeRequiredDescription
taskDocIdstringYesThe task-document's integer ID.
bodystringYesJSON object with the vote 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
taskDocIdinteger (optional)
rawobject (optional)

update_review_task_end_date​

Not currently available

Updates the end date of a review task by its integer ID in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. {"endDate":"2026-08-15T00:00:00Z"}). Requires confirmed=true after showing the user the exact new end date. Returns the updated task.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID.
bodystringYesJSON object carrying the new end date in PM wire form. 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
taskIdinteger (optional)
rawobject (optional)

update_review_task_estimated_duration​

Updates the estimated duration of a review task by its integer ID in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (e.g. {"estimatedDuration":480}). Requires confirmed=true after showing the user the exact new estimated duration. Returns the updated task.

Parameters:

ParameterTypeRequiredDescription
reviewTaskIdstringYesThe review task's integer ID.
bodystringYesJSON object carrying the new estimated duration in PM wire form. 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
taskIdinteger (optional)
rawobject (optional)

Annotate PM Documents​

Can change data · 4 tools (1 currently available) · Group ID annotate-pm-documents

Needs: Manage Supporting Documents

ToolWhat it does
create_public_xfdf_annotationNot currently available. Creates an XFDF annotation on a document version, in Aprimo Marketing Operations (the public assets/annotations-data resource).
delete_public_xfdf_annotationNot currently available. Destructive. Permanently deletes an XFDF annotation from a document version, in Aprimo Marketing Operations (the public assets/annotations-data resource).
get_dam_record_reference_documentsReturns the DAM reference documents linked to a DAM record, in Aprimo Marketing Operations.
get_public_xfdf_annotationsNot currently available. Returns the XFDF annotations for a document version, paged, in Aprimo Marketing Operations (the public assets/annotations-data resource).

create_public_xfdf_annotation​

Not currently available

Creates an XFDF annotation on a document version, in Aprimo Marketing Operations (the public assets/annotations-data resource). Requires confirmed=true after showing the user the exact payload. Returns the created annotation.

Parameters:

ParameterTypeRequiredDescription
idstringYesThe asset (document)'s integer id.
versionIdstringYesThe document version's integer id.
bodystringYesJSON object with the XFDF annotation payload. Must include a "type" property identifying the annotation kind.
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
annotationIdinteger
annotationUuidstring (optional)
associatedNumberinteger (optional)
createdDatestring (optional)
modifiedDatestring (optional)
replyCountinteger (optional)
typestring (optional)
pageinteger (optional)
authorIdinteger (optional)
commentstring (optional)Flattened from content.comment.
quotedTextstring (optional)Flattened from content.quotedText.
fixedLabelstring (optional)Flattened from content.fixedLabel (a stamp/fixed-annotation's label, when present) -- newly surfaced now that ContentModel is a confirmed, hardened schema.
colorstring (optional)Flattened from style.color.
opacitynumber (optional)Flattened from style.opacity.
widthinteger (optional)Flattened from style.width.
referenceDocumentUuidstring (optional)Flattened from referenceLink.documentUuid.

delete_public_xfdf_annotation​

Destructive · Not currently available

Permanently deletes an XFDF annotation from a document version, in Aprimo Marketing Operations (the public assets/annotations-data resource). This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact annotation with the user.

Parameters:

ParameterTypeRequiredDescription
idstringYesThe asset (document)'s integer id.
versionIdstringYesThe document version's integer id.
annotationIdstringYesThe annotation's integer id to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting an annotation is permanent and cannot be undone. Set only after stating the exact annotation to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
idinteger
versionIdinteger
annotationIdinteger
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_dam_record_reference_documents​

Returns the DAM reference documents linked to a DAM record, in Aprimo Marketing Operations.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
recordIdstringYesThe DAM record's GUID (a string, not an integer id).

Returns:

FieldTypeDescription
itemsarray of RefDocsModel
items[].fileVersionIdstring (optional)
items[].refDocsarray of RefDocsProjection
items[].refDocs[].refDocRecordIdstring (optional)
items[].refDocs[].refDocFileVersionIdstring (optional)
items[].refDocs[].refDocAssetTitlestring (optional)

get_public_xfdf_annotations​

Not currently available

Returns the XFDF annotations for a document version, paged, in Aprimo Marketing Operations (the public assets/annotations-data resource).

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
idstringYesThe asset (document)'s integer id.
versionIdstringYesThe document version's integer id.
offsetintegerNoThe zero-based index of the first annotation to return (default 0).
limitintegerNoThe maximum number of annotations to return (default 50).

Returns:

FieldTypeDescription
totalCountinteger
offsetinteger
limitinteger
itemsarray of PublicXfdfAnnotationProjection
items[].annotationIdinteger
items[].annotationUuidstring (optional)
items[].associatedNumberinteger (optional)
items[].createdDatestring (optional)
items[].modifiedDatestring (optional)
items[].replyCountinteger (optional)
items[].typestring (optional)
items[].pageinteger (optional)
items[].authorIdinteger (optional)
items[].commentstring (optional)Flattened from content.comment.
items[].quotedTextstring (optional)Flattened from content.quotedText.
items[].fixedLabelstring (optional)Flattened from content.fixedLabel (a stamp/fixed-annotation's label, when present) -- newly surfaced now that ContentModel is a confirmed, hardened schema.
items[].colorstring (optional)Flattened from style.color.
items[].opacitynumber (optional)Flattened from style.opacity.
items[].widthinteger (optional)Flattened from style.width.
items[].referenceDocumentUuidstring (optional)Flattened from referenceLink.documentUuid.

Manage Supporting Documents​

Can change data · 22 tools (18 currently available) · Group ID manage-supporting-documents-digital-assets

Needs: View Projects, View Task Details & Assignments, Look Up PM Users, Groups & Roles, Find & Discover Content

ToolWhat it does
add_attachment_to_projectAssociates an attachment with a project in Aprimo Marketing Operations.
add_digital_asset_to_projectAssociates a digital asset with a project in Aprimo Marketing Operations.
cancel_attachment_checkoutCancels the checkout of an attachment, releasing the lock without checking in a new version, in Aprimo Marketing Operations.
checkin_attachment_versionNot currently available. Checks in a new version of an attachment, releasing its checkout, in Aprimo Marketing Operations.
checkout_attachmentChecks out an attachment (locks it for editing) in Aprimo Marketing Operations.
create_attachmentCreates a new attachment in Aprimo Marketing Operations.
create_attachment_versionCreates a new version of an attachment, in Aprimo Marketing Operations.
delete_attachmentDestructive. Permanently deletes an attachment by id in Aprimo Marketing Operations.
delete_attachment_versionNot currently available. Destructive. Permanently deletes a specific version of an attachment, in Aprimo Marketing Operations.
get_attachmentReturns a single attachment by id in Aprimo Marketing Operations.
get_attachment_taggable_usersReturns the users that can be tagged on an attachment, in Aprimo Marketing Operations.
get_attachment_versionReturns a single attachment version by id, in Aprimo Marketing Operations.
get_attachment_versionsReturns all versions of an attachment, in Aprimo Marketing Operations.
get_digital_assetReturns a single digital asset by id in Aprimo Marketing Operations.
get_project_attachmentsReturns the attachments associated with a project, in Aprimo Marketing Operations.
get_task_attachmentsReturns the attachments assigned to a task, paged, in Aprimo Marketing Operations.
remove_attachment_from_projectDestructive. Permanently removes the association between an attachment and a project in Aprimo Marketing Operations (the attachment itself is not deleted).
retrieve_digital_asset_dam_mappingResolves a DAM record and/or file mapping to its corresponding digital asset in Aprimo Marketing Operations.
search_attachmentsSearches attachments in Aprimo Marketing Operations that match a query, paged.
send_attachment_version_new_version_notificationNot currently available. Sends a new-version notification email about an attachment version to the users/groups named in the body, using the supplied subject and message, in Aprimo Marketing Operations.
update_attachmentUpdates an existing attachment by id in Aprimo Marketing Operations.
update_attachment_versionNot currently available. Updates an existing attachment version, in Aprimo Marketing Operations.

add_attachment_to_project​

Associates an attachment with a project in Aprimo Marketing Operations. Requires confirmed=true after confirming the exact project/attachment with the user.

Parameters:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer id.
attachmentIdstringYesThe attachment's integer id to associate with the project.
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.

Returns:

FieldTypeDescription
projectIdinteger
attachmentIdinteger
succeededboolean
rawobject (optional)The raw response body, verbatim, for full fidelity.

add_digital_asset_to_project​

Associates a digital asset with a project in Aprimo Marketing Operations. Requires confirmed=true after confirming the exact project/digital asset with the user.

Parameters:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer id.
digitalAssetIdstringYesThe digital asset's integer id to associate with the project.
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.

Returns:

FieldTypeDescription
projectIdinteger
digitalAssetIdinteger
succeededboolean
rawobject (optional)The raw response body, verbatim (best-effort; PM declares no content schema), for full fidelity.

cancel_attachment_checkout​

Cancels the checkout of an attachment, releasing the lock without checking in a new version, in Aprimo Marketing Operations. Undoes checkout_attachment (safe). Requires confirmed=true after confirming the exact attachment with the user.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id whose checkout to cancel.
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.

Returns:

FieldTypeDescription
attachmentIdinteger
actionstring (optional)The action performed: "checkout" or "cancel-checkout".
succeededboolean

checkin_attachment_version​

Not currently available

Checks in a new version of an attachment, releasing its checkout, in Aprimo Marketing Operations. Adds a version (additive, not destructive). Requires confirmed=true after confirming the exact attachment/version with the user.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id to check in.
versionIdstringYesThe new attachment version's integer id.
taskIdstringYesThe task identifier associated with the attachment.
taskDocIdstringYesThe task document identifier associated with the attachment.
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.

Returns:

FieldTypeDescription
attachmentIdinteger
versionIdinteger
taskIdinteger
taskDocIdinteger
succeededboolean

checkout_attachment​

Checks out an attachment (locks it for editing) in Aprimo Marketing Operations. Reversible via cancel_attachment_checkout. Requires confirmed=true after confirming the exact attachment with the user.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id to check out.
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.

Returns:

FieldTypeDescription
attachmentIdinteger
actionstring (optional)The action performed: "checkout" or "cancel-checkout".
succeededboolean

create_attachment​

Creates a new attachment in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created attachment.

Parameters:

ParameterTypeRequiredDescription
bodystringYesJSON object with the new attachment's data (PM wire names).
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 (optional)
objectTypeIdinteger (optional)
attachmentTypeIdinteger (optional)
attachmentTypestring (optional)
projectVisibilityboolean (optional)
modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
modifiedByNamestring (optional)
modifiedDatestring (optional)
creatorIdinteger (optional)
creatorNamestring (optional)
checkedOutDatestring (optional)
checkedOutByinteger (optional)PM wires this as checkedOutBy, not checkedOutById.
checkedOutByNamestring (optional)
documentIdinteger (optional)
documentNamestring (optional)
documentTypestring (optional)
isDocumentDamAssetboolean (optional)
damRecordIdstring (optional)
isReferenceDocumentboolean

create_attachment_version​

Creates a new version of an attachment, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created attachment version.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id.
bodystringYesJSON object with the new attachment version's data (PM wire names).
taskIdintegerNoOptional task identifier the version is associated with. Default 0 (no associated task).
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)
thumbnailUristring (optional)
downloadUristring (optional)
modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
modifiedByNamestring (optional)
modifiedDatestring (optional)
createdDatestring (optional)
creatorIdinteger (optional)
creatorNamestring (optional)
fileIdstring (optional)
titlestring (optional)
descriptionstring (optional)
versionCommentsstring (optional)

delete_attachment​

Destructive

Permanently deletes an attachment by id in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact attachment with the user.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's id to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting an attachment is permanent and cannot be undone. Set only after stating the exact attachment to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
attachmentIdstring (optional)
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.


delete_attachment_version​

Destructive · Not currently available

Permanently deletes a specific version of an attachment, in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact version with the user.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id.
versionIdstringYesThe attachment version's integer id to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting an attachment version is permanent and cannot be undone. Set only after stating the exact version to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
attachmentIdinteger
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_attachment​

Returns a single attachment by id in Aprimo Marketing Operations. Not its taggable users (get_attachment_taggable_users), a specific version (get_attachment_version), or its version list (get_attachment_versions).

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's id.

Returns:

FieldTypeDescription
attachmentIdinteger
titlestring (optional)
descriptionstring (optional)
objectIdinteger (optional)
objectTypeIdinteger (optional)
attachmentTypeIdinteger (optional)
attachmentTypestring (optional)
projectVisibilityboolean (optional)
modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
modifiedByNamestring (optional)
modifiedDatestring (optional)
creatorIdinteger (optional)
creatorNamestring (optional)
checkedOutDatestring (optional)
checkedOutByinteger (optional)PM wires this as checkedOutBy, not checkedOutById.
checkedOutByNamestring (optional)
documentIdinteger (optional)
documentNamestring (optional)
documentTypestring (optional)
isDocumentDamAssetboolean (optional)
damRecordIdstring (optional)
isReferenceDocumentboolean

get_attachment_taggable_users​

Returns the users that can be tagged on an attachment, in Aprimo Marketing Operations.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id.
nameFilterstringNoOptional case-insensitive substring filter on the user's first or last name. Omit to match all taggable users.
applyMostRecentTagsbooleanNoIf true, sorts by most recently tagged users.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).

Returns:

FieldTypeDescription
itemsarray of TaggableUserProjection
items[].idinteger (optional)
items[].firstNamestring (optional)
items[].lastNamestring (optional)
items[].lastTagDatestring (optional)
items[].tagCountinteger (optional)

get_attachment_version​

Returns a single attachment version by id, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's id.
versionIdstringYesThe attachment version's id.
contextTypeintegerNoOptional annotation context type filter.
contextObjectIdintegerNoOptional annotation context object id filter.
includeFileSizebooleanNoIf true, includes the file size in the response.

Returns:

FieldTypeDescription
versionIdinteger
isDefaultVersionboolean
attachmentIdinteger
filenamestring (optional)
extensionstring (optional)
thumbnailUristring (optional)
downloadUristring (optional)
modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
modifiedByNamestring (optional)
modifiedDatestring (optional)
createdDatestring (optional)
creatorIdinteger (optional)
creatorNamestring (optional)
fileIdstring (optional)
titlestring (optional)
descriptionstring (optional)
versionCommentsstring (optional)

get_attachment_versions​

Returns all versions of an attachment, in Aprimo Marketing Operations.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id.

Returns:

FieldTypeDescription
totalRecordsinteger
itemsarray of AttachmentVersionProjection
items[].versionIdinteger
items[].isDefaultVersionboolean
items[].attachmentIdinteger
items[].filenamestring (optional)
items[].extensionstring (optional)
items[].thumbnailUristring (optional)
items[].downloadUristring (optional)
items[].modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
items[].modifiedByNamestring (optional)
items[].modifiedDatestring (optional)
items[].createdDatestring (optional)
items[].creatorIdinteger (optional)
items[].creatorNamestring (optional)
items[].fileIdstring (optional)
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].versionCommentsstring (optional)

get_digital_asset​

Returns a single digital asset by id in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
digitalAssetIdstringYesThe digital asset's id.

Returns:

FieldTypeDescription
assetIdinteger
titlestring (optional)
descriptionstring (optional)
typeinteger (optional)Raw digital-asset type id.
assetTypestring (optional)Digital-asset type display name.
assetStatusinteger (optional)Raw asset status id.
restrictionStatusinteger (optional)Raw restriction status id.
hasVersionsboolean
expirationDatestring (optional)
createdDatestring (optional)
modifiedDatestring (optional)
modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
ownerIdinteger (optional)
checkedOutDatestring (optional)
checkedOutByinteger (optional)PM wires this as checkedOutBy, not checkedOutById.
isReferenceDocumentboolean
documentIdinteger (optional)
documentNamestring (optional)
documentTypestring (optional)
isDocumentDamAssetboolean (optional)
damRecordIdstring (optional)
damFileIdstring (optional)
contentTypestring (optional)
canDownloadboolean

get_project_attachments​

Returns the attachments associated with a project, in Aprimo Marketing Operations.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer id.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of AttachmentProjectionThe items returned in this response.
items[].attachmentIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].objectIdinteger (optional)
items[].objectTypeIdinteger (optional)
items[].attachmentTypeIdinteger (optional)
items[].attachmentTypestring (optional)
items[].projectVisibilityboolean (optional)
items[].modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
items[].modifiedByNamestring (optional)
items[].modifiedDatestring (optional)
items[].creatorIdinteger (optional)
items[].creatorNamestring (optional)
items[].checkedOutDatestring (optional)
items[].checkedOutByinteger (optional)PM wires this as checkedOutBy, not checkedOutById.
items[].checkedOutByNamestring (optional)
items[].documentIdinteger (optional)
items[].documentNamestring (optional)
items[].documentTypestring (optional)
items[].isDocumentDamAssetboolean (optional)
items[].damRecordIdstring (optional)
items[].isReferenceDocumentboolean

get_task_attachments​

Returns the attachments assigned to a task, paged, 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 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}/attachments) instead of the plain task route. Default false.
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
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of AttachmentProjectionThe items returned in this response.
items[].attachmentIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].objectIdinteger (optional)
items[].objectTypeIdinteger (optional)
items[].attachmentTypeIdinteger (optional)
items[].attachmentTypestring (optional)
items[].projectVisibilityboolean (optional)
items[].modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
items[].modifiedByNamestring (optional)
items[].modifiedDatestring (optional)
items[].creatorIdinteger (optional)
items[].creatorNamestring (optional)
items[].checkedOutDatestring (optional)
items[].checkedOutByinteger (optional)PM wires this as checkedOutBy, not checkedOutById.
items[].checkedOutByNamestring (optional)
items[].documentIdinteger (optional)
items[].documentNamestring (optional)
items[].documentTypestring (optional)
items[].isDocumentDamAssetboolean (optional)
items[].damRecordIdstring (optional)
items[].isReferenceDocumentboolean

remove_attachment_from_project​

Destructive

Permanently removes the association between an attachment and a project in Aprimo Marketing Operations (the attachment itself is not deleted). This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact project/attachment with the user.

Parameters:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer id.
attachmentIdstringYesThe attachment's integer id to remove from the project.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — removing an attachment's project association is permanent and cannot be undone. Set only after stating the exact project/attachment to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
projectIdinteger
attachmentIdinteger
removedboolean
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.


retrieve_digital_asset_dam_mapping​

Resolves a DAM record and/or file mapping to its corresponding digital asset in Aprimo Marketing Operations. Read-only despite the POST verb -- a query/lookup operation, no resource is created or changed.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
bodystringYesJSON object with the DAM record and/or file identifiers to resolve (e.g. damFileId, damRecordId, assetTypeId, isLocalUpload — PM wire names).

Returns:

FieldTypeDescription
assetIdinteger
titlestring (optional)
descriptionstring (optional)
typeinteger (optional)Raw digital-asset type id.
assetTypestring (optional)Digital-asset type display name.
assetStatusinteger (optional)Raw asset status id.
restrictionStatusinteger (optional)Raw restriction status id.
hasVersionsboolean
expirationDatestring (optional)
createdDatestring (optional)
modifiedDatestring (optional)
modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
ownerIdinteger (optional)
checkedOutDatestring (optional)
checkedOutByinteger (optional)PM wires this as checkedOutBy, not checkedOutById.
isReferenceDocumentboolean
documentIdinteger (optional)
documentNamestring (optional)
documentTypestring (optional)
isDocumentDamAssetboolean (optional)
damRecordIdstring (optional)
damFileIdstring (optional)
contentTypestring (optional)
canDownloadboolean

search_attachments​

Searches attachments in Aprimo Marketing Operations that match a query, paged. A query is required -- PM has no match-all query for this endpoint; use get_task_attachments or get_project_attachments to browse a specific task's or project's attachments without a query.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
querystringNoJSON object with the query (PM's operator-tree DSL, e.g. {"equals":{"FieldName":"ObjectId","FieldValue":123}}). Required -- PM rejects an empty "{}" query, so this cannot be omitted; use get_task_attachments/get_project_attachments to browse without a query.
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
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of AttachmentProjectionThe items returned in this response.
items[].attachmentIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].objectIdinteger (optional)
items[].objectTypeIdinteger (optional)
items[].attachmentTypeIdinteger (optional)
items[].attachmentTypestring (optional)
items[].projectVisibilityboolean (optional)
items[].modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
items[].modifiedByNamestring (optional)
items[].modifiedDatestring (optional)
items[].creatorIdinteger (optional)
items[].creatorNamestring (optional)
items[].checkedOutDatestring (optional)
items[].checkedOutByinteger (optional)PM wires this as checkedOutBy, not checkedOutById.
items[].checkedOutByNamestring (optional)
items[].documentIdinteger (optional)
items[].documentNamestring (optional)
items[].documentTypestring (optional)
items[].isDocumentDamAssetboolean (optional)
items[].damRecordIdstring (optional)
items[].isReferenceDocumentboolean

send_attachment_version_new_version_notification​

Not currently available

Sends a new-version notification email about an attachment version to the users/groups named in the body, using the supplied subject and message, in Aprimo Marketing Operations. PM's snapshot declares the request body as opaque -- pass the exact wire-shape JSON object PM expects (recipients/subject/message). Requires confirmed=true after showing the user the exact payload.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id.
versionIdstringYesThe attachment version's integer id.
bodystringYesJSON object with the notification data (PM wire names, e.g. recipients/subject/message). 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
versionIdinteger
succeededboolean
rawobject (optional)

update_attachment​

Updates an existing attachment by id in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated attachment.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's id.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
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
attachmentIdinteger
titlestring (optional)
descriptionstring (optional)
objectIdinteger (optional)
objectTypeIdinteger (optional)
attachmentTypeIdinteger (optional)
attachmentTypestring (optional)
projectVisibilityboolean (optional)
modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
modifiedByNamestring (optional)
modifiedDatestring (optional)
creatorIdinteger (optional)
creatorNamestring (optional)
checkedOutDatestring (optional)
checkedOutByinteger (optional)PM wires this as checkedOutBy, not checkedOutById.
checkedOutByNamestring (optional)
documentIdinteger (optional)
documentNamestring (optional)
documentTypestring (optional)
isDocumentDamAssetboolean (optional)
damRecordIdstring (optional)
isReferenceDocumentboolean

update_attachment_version​

Not currently available

Updates an existing attachment version, in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated attachment version.

Parameters:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer id.
versionIdstringYesThe attachment version's integer id.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
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
versionIdinteger
isDefaultVersionboolean
attachmentIdinteger
filenamestring (optional)
extensionstring (optional)
thumbnailUristring (optional)
downloadUristring (optional)
modifiedUserinteger (optional)PM wires this as modifiedUser, not modifiedById.
modifiedByNamestring (optional)
modifiedDatestring (optional)
createdDatestring (optional)
creatorIdinteger (optional)
creatorNamestring (optional)
fileIdstring (optional)
titlestring (optional)
descriptionstring (optional)
versionCommentsstring (optional)

Collaborate in Chatboards​

Can change data · 14 tools (11 currently available) · Group ID collaborate-in-chatboards

Needs: Look Up PM Users, Groups & Roles

ToolWhat it does
create_chatboard_for_objectCreates a chatboard for the specified object in Aprimo Marketing Operations.
create_chatboard_messageNot currently available. Creates a chatboard message in Aprimo Marketing Operations and returns the persisted message.
delete_chatboardDestructive. Permanently deletes a chatboard by its integer ID in Aprimo Marketing Operations.
get_chatboardReturns a single chatboard by its integer ID in Aprimo Marketing Operations, including its hypermedia action links (messages, parent, delete, read-all).
get_chatboard_by_objectReturns the chatboard for the given id and object, in Aprimo Marketing Operations.
get_chatboard_from_objectReturns the chatboard associated with the given parent object in Aprimo Marketing Operations.
get_chatboard_legacy_linksReturns the legacy links associated with the given chatboard object, by its integer ID, in Aprimo Marketing Operations.
get_project_chat_accessDetermines whether the current user has chat access to a project in Aprimo Marketing Operations.
list_chatboard_filtersLists the filters available for chatboards in Aprimo Marketing Operations.
list_chatboard_messagesReturns a chatboard's messages, by the chatboard's integer ID, in Aprimo Marketing Operations.
list_chatboard_statusesNot currently available. Returns chatboard statuses for the given object type, by its integer ID, in Aprimo Marketing Operations.
read_all_chatboard_messagesMarks all messages in the specified chatboard as read for the current user, in Aprimo Marketing Operations.
read_all_inbox_messagesNot currently available. Marks all messages as read for the current user, across all of their chatboards, in Aprimo Marketing Operations.
read_chatboard_messageMarks the specified message as read for the current user in Aprimo Marketing Operations.

create_chatboard_for_object​

Creates a chatboard for the specified object in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact object being chat-enabled. Returns the created chatboard.

Parameters:

ParameterTypeRequiredDescription
objectTypeIdstringYesThe parent object's integer type ID.
objectIdstringYesThe parent object's integer ID.
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 creating the chatboard.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above.

create_chatboard_message​

Not currently available

Creates a chatboard message in Aprimo Marketing Operations and returns the persisted message. Requires confirmed=true after showing the user the exact payload.

Parameters:

ParameterTypeRequiredDescription
bodystringYesJSON object with the new message's data (PM wire names), including the target chatboard's id.
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
idstring (optional)
textstring (optional)The message body/text, when present under any of the common wire names.
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above.

delete_chatboard​

Destructive

Permanently deletes a chatboard by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact chatboard with the user.

Parameters:

ParameterTypeRequiredDescription
chatboardIdstringYesThe chatboard's integer ID to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust also be true (in addition to confirmed) — deleting a chatboard is permanent and cannot be undone. Set only after stating the exact chatboard to the user and getting explicit go-ahead.

Returns:

FieldTypeDescription
chatboardIdinteger
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_chatboard​

Returns a single chatboard by its integer ID in Aprimo Marketing Operations, including its hypermedia action links (messages, parent, delete, read-all). Not a lookup by object (get_chatboard_by_object or get_chatboard_from_object) or its legacy links (get_chatboard_legacy_links).

Parameters:

ParameterTypeRequiredDescription
chatboardIdstringYesThe chatboard's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above.

get_chatboard_by_object​

Returns the chatboard for the given id and object, in Aprimo Marketing Operations. Important: per PM's own documented behavior, passing chatboardId=0 can auto-create a new chatboard for the object (server-controlled, not observable or suppressible from here) -- when chatboardId=0, confirmed=true is required after telling the user a chatboard may be created. Any non-zero chatboardId is a pure read, no confirmation needed.

Parameters:

ParameterTypeRequiredDescription
chatboardIdstringYesThe chatboard's integer ID, or 0 to look up/possibly auto-create one for the object below.
objectTypeIdstringYesThe parent object's integer type ID.
objectIdstringYesThe parent object's integer ID.
confirmedbooleanNoRequired (must be true) only when chatboardId=0, since that path can auto-create a chatboard. Ignored for any non-zero chatboardId.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above.

get_chatboard_from_object​

Returns the chatboard associated with the given parent object in Aprimo Marketing Operations.

Parameters:

ParameterTypeRequiredDescription
objectIdstringYesThe parent object's integer ID.
objectTypeIdstringYesThe parent object's integer type ID.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above.

Returns the legacy links associated with the given chatboard object, by its integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
idstringYesThe object's integer ID.

Returns:

FieldTypeDescription
countinteger (optional)
rawobject (optional)

get_project_chat_access​

Determines whether the current user has chat access to a project in Aprimo Marketing Operations.

Parameters:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID.

Returns:

FieldTypeDescription
projectIdinteger
hasAccessboolean

list_chatboard_filters​

Lists the filters available for chatboards in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters: none.

Returns:

FieldTypeDescription
countinteger (optional)
rawobject (optional)

list_chatboard_messages​

Returns a chatboard's messages, by the chatboard's integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
chatboardIdstringYesThe chatboard's integer ID.

Returns:

FieldTypeDescription
countinteger (optional)
rawobject (optional)

list_chatboard_statuses​

Not currently available

Returns chatboard statuses for the given object type, by its integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
objectTypeIdstringYesThe object type's integer ID.

Returns:

FieldTypeDescription
countinteger (optional)
rawobject (optional)

read_all_chatboard_messages​

Marks all messages in the specified chatboard as read for the current user, in Aprimo Marketing Operations. Requires confirmed=true after confirming the exact chatboard with the user.

Parameters:

ParameterTypeRequiredDescription
chatboardIdstringYesThe chatboard's integer ID.
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 marking all messages read.

Returns:

FieldTypeDescription
chatboardIdinteger (optional)
messageIdinteger (optional)
actionstring (optional)The action performed: "read", "read-all-messages", or "read-all-inbox-messages".
succeededboolean
rawobject (optional)The complete wire response, verbatim, since the real response shape is unverified.

read_all_inbox_messages​

Not currently available

Marks all messages as read for the current user, across all of their chatboards, in Aprimo Marketing Operations. Requires confirmed=true after confirming this affects every chatboard the user is in, not just one.

Parameters:

ParameterTypeRequiredDescription
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 marking all inbox messages read.

Returns:

FieldTypeDescription
chatboardIdinteger (optional)
messageIdinteger (optional)
actionstring (optional)The action performed: "read", "read-all-messages", or "read-all-inbox-messages".
succeededboolean
rawobject (optional)The complete wire response, verbatim, since the real response shape is unverified.

read_chatboard_message​

Marks the specified message as read for the current user in Aprimo Marketing Operations. Requires confirmed=true after confirming the exact message with the user.

Parameters:

ParameterTypeRequiredDescription
messageIdstringYesThe message's integer ID to mark as read.
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 marking the message read.

Returns:

FieldTypeDescription
chatboardIdinteger (optional)
messageIdinteger (optional)
actionstring (optional)The action performed: "read", "read-all-messages", or "read-all-inbox-messages".
succeededboolean
rawobject (optional)The complete wire response, verbatim, since the real response shape is unverified.