Tasks & Assignments
Tools for the task lifecycle in Aprimo Productivity Management — finding and updating tasks, accepting or declining assignments, assignees and delegation, checklists, data collection templates, task links, workflow teams, and time tracking.
This page covers 40 tools, 22 of them in the default tool list, and 3 destructive.
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
accept_task | Default | Accepts a task assignment, by the task's integer ID, in Aprimo Marketing Operations. |
close_task | On request | Destructive. Closes a task (workflow assignment) in Aprimo Marketing Operations. |
decline_task | Default | Destructive. Declines a task (workflow assignment) in Aprimo Marketing Operations. |
delegate_task | On request | Destructive. Delegates a task (workflow assignment) to another user in Aprimo Marketing Operations. |
get_project_tasks | Default | Lists the tasks that belong to a Project, by the project's integer ID, in Aprimo Marketing Operations. |
get_review_task_assignee | On request | 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_link | On request | Returns a single task link belonging to the specified review task, in Aprimo Marketing Operations. |
get_task | Default | Returns a single task (workflow assignment) by its integer ID from Aprimo Marketing Operations. |
get_task_assignee | Default | Returns 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_detail | Default | Returns the time-detail record for the task assignee, by its integer ID, in Aprimo Marketing Operations. |
get_task_assignees | Default | Returns the assignee records for a task, by the task's integer ID, in Aprimo Marketing Operations. |
get_task_checklist | On request | Returns a single checklist, including its checklist items, for an assignment task in Aprimo Marketing Operations. |
get_task_checklist_results | On request | Returns the saved results for a checklist on a task assignment, in Aprimo Marketing Operations. |
get_task_dct | On request | 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_results | On request | Returns the saved data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations. |
get_task_link | On request | Returns a single task link belonging to the specified (non-review) assignment task, in Aprimo Marketing Operations. |
get_task_time_entry | Default | Returns a single workflow task time entry by its integer ID in Aprimo Marketing Operations. |
get_team | On request | Returns a single workflow team by its integer ID in Aprimo Marketing Operations, including its members. |
list_review_task_delegation_users | On request | 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_links | Default | Lists the task links on a review task, by the review task's integer ID, in Aprimo Marketing Operations. |
list_task_checklists | Default | Lists the checklists on an assignment task, by the task's integer ID, in Aprimo Marketing Operations. |
list_task_dcts | Default | Lists the data collection templates (DCTs) associated with an assignment task, by the task's integer ID, in Aprimo Marketing Operations. |
list_task_delegation_users | On request | 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_links | Default | Lists the task links on a (non-review) assignment task, by the task's integer ID, in Aprimo Marketing Operations. |
list_tasks | Default | Lists tasks (workflow assignments) in Aprimo Marketing Operations, paged and unfiltered. |
list_teams | On request | Lists workflow teams in Aprimo Marketing Operations, paged, with an optional title filter. |
search_task_time_entries | Default | Searches workflow task time entries in Aprimo Marketing Operations with a JSON query body, paged and sortable. |
search_tasks | Default | Searches tasks (workflow assignments) in Aprimo Marketing Operations. |
update_task | Default | Updates an existing task (workflow assignment) by its integer ID in Aprimo Marketing Operations. |
update_task_assignee | On request | 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_detail | Default | Updates the task assignee's time-detail record, by its integer ID, in Aprimo Marketing Operations. |
update_task_begin_date | Default | Updates the begin date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. |
update_task_checklist_results | On request | Saves the submitted results for a checklist on a task assignment, in Aprimo Marketing Operations. |
update_task_dct_results | On request | Saves data collection template (DCT) result values for a DCT on a task assignment, in Aprimo Marketing Operations. |
update_task_end_date | Default | Updates the end date of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. |
update_task_estimated_duration | Default | Updates the estimated duration of a task (workflow assignment) by its integer ID in Aprimo Marketing Operations. |
validate_task_assignee | Default | Validates whether the current user's work on the specified task can be closed, in Aprimo Marketing Operations. |
validate_task_assignee_time_detail | Default | Validates the supplied time-detail data for a task assignee without persisting any changes, by the record's integer ID, in Aprimo Marketing Operations. |
validate_task_checklist_results | On request | Validates a checklist's results to determine whether the task can be closed, in Aprimo Marketing Operations. |
validate_task_dct_results | On request | 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. |
accept_task
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID to accept. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved. |
Returns:
| Field | Type | Description |
|---|---|---|
actionId | string (optional) | |
taskId | integer | |
assigneeId | integer | |
status | integer | |
message | string (optional) |
close_task
Available on request · Destructive
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID to close. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — 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. |
promoteAnnotations | boolean | No | When true, promote the task's annotations on close. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
action | string (optional) | The state-change action performed: "close", "decline", or "delegate". |
succeeded | boolean | |
delegatedToUserId | integer (optional) | For delegate_task only: the user the task was delegated to. |
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
In the default tool list · 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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID to decline. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — declining a task changes its state. Set only after stating the exact task to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
action | string (optional) | The state-change action performed: "close", "decline", or "delegate". |
succeeded | boolean | |
delegatedToUserId | integer (optional) | For delegate_task only: the user the task was delegated to. |
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
Available on request · Destructive
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID to delegate. |
taskAssigneeId | string | Yes | The task assignee record's integer ID (the assignment being delegated). |
newUserId | string | Yes | The integer user ID to delegate the task to. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — 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:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
action | string (optional) | The state-change action performed: "close", "decline", or "delegate". |
succeeded | boolean | |
delegatedToUserId | integer (optional) | For delegate_task only: the user the task was delegated to. |
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_project_tasks
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The parent project's integer ID. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by (e.g. 'ModifiedDate', 'Name'). Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
excludeAutoClose | boolean | No | When true, omit auto-close tasks. Default false (include all). |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of TaskProjection | The items returned in this response. |
items[].taskId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | |
items[].statusLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].estimatedDuration | integer (optional) | |
items[].projectId | integer | |
items[].projectTitle | string (optional) | |
items[].projectDeepLink | string (optional) | |
items[].activityId | integer (optional) | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].modifiedById | integer (optional) | |
items[].modifiedByName | string (optional) | |
items[].completedById | integer (optional) | |
items[].completedByName | string (optional) | |
items[].canClose | boolean (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[].canDelegate | boolean (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[].canDecline | boolean (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[].daysOverDue | integer (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_review_task_assignee
Available on request
Returns the current user's assignment record for the specified review task, by the review task's integer ID, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) |
get_review_task_link
Available on request
Returns a single task link belonging to the specified review task, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The review task's integer ID. |
linkId | string | Yes | The task link's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above. |
get_task
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (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 . |
canDelegate | boolean (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). |
canDecline | boolean (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). |
daysOverDue | integer (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
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) |
get_task_assignee_time_detail
In the default tool list
Returns the time-detail record for the task assignee, by its integer ID, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The task assignee time-detail record's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted field above. |
get_task_assignees
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
totalRecords | integer | |
items | array of TaskAssigneeItemProjection | |
items[].assigneeId | integer | |
items[].taskId | integer | |
items[].userId | integer (optional) | |
items[].userName | string (optional) | |
items[].workStatus | integer | |
items[].canClose | boolean | |
items[].voteResult | integer (optional) | |
items[].comments | string (optional) | |
items[].assignedDate | string (optional) | |
items[].completedDate | string (optional) | |
items[].actualBeginDate | string (optional) | |
items[].actualEndDate | string (optional) | |
items[].roleId | integer (optional) | |
items[].estimatedWork | integer (optional) | Estimated work (in the task's work-unit), newly confirmed by the hardened schema. |
items[].actualWork | integer (optional) | Actual work logged so far, newly confirmed by the hardened schema. |
items[].sequence | integer (optional) | The assignee's sequence/ordering within the task, newly confirmed by the hardened schema. |
get_task_checklist
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
checklistId | string | Yes | The checklist's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (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
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
checklistId | string | Yes | The checklist's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
get_task_dct
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
dctId | string | Yes | The DCT's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (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
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
dctId | string | Yes | The DCT's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
get_task_link
Available on request
Returns a single task link belonging to the specified (non-review) assignment task, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
linkId | string | Yes | The task link's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above. |
get_task_time_entry
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The task time entry's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted field above. |
get_team
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
teamId | string | Yes | The team's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
teamId | integer | |
name | string (optional) | |
description | string (optional) | |
members | array of TeamMemberProjection | |
members[].teamMemberId | integer | |
members[].teamId | integer | |
members[].roleId | integer (optional) | |
members[].userId | integer (optional) | |
members[].userName | string (optional) | |
members[].hasEditRight | boolean (optional) | |
members[].hasFinancialsEditRight | boolean (optional) |
list_review_task_delegation_users
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
reviewTaskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of DelegationUserProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above. |
list_review_task_links
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The review task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of TaskLinkProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above. |
list_task_checklists
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of TaskChecklistProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (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
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of TaskDctProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (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. |
list_task_delegation_users
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of DelegationUserProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above. |
list_task_links
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of TaskLinkProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].name | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted fields above. |
list_tasks
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by (e.g. 'ModifiedDate', 'Name'). Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of TaskProjection | The items returned in this response. |
items[].taskId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | |
items[].statusLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].estimatedDuration | integer (optional) | |
items[].projectId | integer | |
items[].projectTitle | string (optional) | |
items[].projectDeepLink | string (optional) | |
items[].activityId | integer (optional) | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].modifiedById | integer (optional) | |
items[].modifiedByName | string (optional) | |
items[].completedById | integer (optional) | |
items[].completedByName | string (optional) | |
items[].canClose | boolean (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[].canDelegate | boolean (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[].canDecline | boolean (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[].daysOverDue | integer (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
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
titleFilter | string | No | Optional case-insensitive substring filter on the team's title. Omit to match all teams. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by (default 'Name'). |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of TeamProjection | The items returned in this response. |
items[].teamId | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].members | array of TeamMemberProjection | |
items[].members[].teamMemberId | integer | |
items[].members[].teamId | integer | |
items[].members[].roleId | integer (optional) | |
items[].members[].userId | integer (optional) | |
items[].members[].userName | string (optional) | |
items[].members[].hasEditRight | boolean (optional) | |
items[].members[].hasFinancialsEditRight | boolean (optional) |
search_task_time_entries
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | JSON-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. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of WfTaskTimeEntryProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted field above. |
search_tasks
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | JSON-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. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by (e.g. 'ModifiedDate', 'Name'). Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
statusLabel | string | No | Filter 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:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of TaskProjection | The items returned in this response. |
items[].taskId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | |
items[].statusLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].estimatedDuration | integer (optional) | |
items[].projectId | integer | |
items[].projectTitle | string (optional) | |
items[].projectDeepLink | string (optional) | |
items[].activityId | integer (optional) | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].modifiedById | integer (optional) | |
items[].modifiedByName | string (optional) | |
items[].completedById | integer (optional) | |
items[].completedByName | string (optional) | |
items[].canClose | boolean (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[].canDelegate | boolean (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[].canDecline | boolean (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[].daysOverDue | integer (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
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (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 . |
canDelegate | boolean (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). |
canDecline | boolean (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). |
daysOverDue | integer (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
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object with the assignment record fields to update (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) |
update_task_assignee_time_detail
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The task assignee time-detail record's integer ID. |
body | string | Yes | JSON 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. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- for full fidelity beyond the defensively-extracted field above. |
update_task_begin_date
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object carrying the new begin date in PM wire form (e.g. {"beginDate":"2026-08-01T00:00:00Z"}). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (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 . |
canDelegate | boolean (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). |
canDecline | boolean (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). |
daysOverDue | integer (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_checklist_results
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
checklistId | string | Yes | The checklist's integer ID. |
body | string | Yes | JSON object with the checklist results to save (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
update_task_dct_results
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
dctId | string | Yes | The DCT's integer ID. |
body | string | Yes | JSON object with the DCT result values to save (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
update_task_end_date
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object carrying the new end date in PM wire form (e.g. {"endDate":"2026-08-15T00:00:00Z"}). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (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 . |
canDelegate | boolean (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). |
canDecline | boolean (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). |
daysOverDue | integer (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
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
body | string | Yes | JSON object carrying the new estimated duration in PM wire form (e.g. {"estimatedDuration":480}). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
taskId | integer | |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | |
statusLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
estimatedDuration | integer (optional) | |
projectId | integer | |
projectTitle | string (optional) | |
projectDeepLink | string (optional) | |
activityId | integer (optional) | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
modifiedById | integer (optional) | |
modifiedByName | string (optional) | |
completedById | integer (optional) | |
completedByName | string (optional) | |
canClose | boolean (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 . |
canDelegate | boolean (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). |
canDecline | boolean (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). |
daysOverDue | integer (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
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The task's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
raw | object (optional) |
validate_task_assignee_time_detail
In the default tool list
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The task assignee time-detail record's integer ID. |
body | string | Yes | JSON object with the time-detail data to validate (PM wire names). |
Returns:
| Field | Type | Description |
|---|---|---|
raw | object (optional) |
validate_task_checklist_results
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
checklistId | string | Yes | The checklist's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
validate_task_dct_results
Available on request
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | The assignment task's integer ID. |
dctId | string | Yes | The DCT's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent