Plan work
Plan marketing work in Productivity Management: activities, programs, proposals, content plans, the calendar, projects, and work requests.
This area has 11 groups and 71 tools, 68 of them currently available.
- 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
confirmedandconfirmedDestructivetotrue. - 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
| Group | Access | Needs | Tools |
|---|---|---|---|
| View Activities | Read-only | Look Up PM Reference Data | 8 |
| Edit Activities | Can change data | View Activities, Look Up PM Reference Data, Look Up PM Users, Groups & Roles | 9 |
| View Programs | Read-only | View Activities | 3 |
| Edit Programs | Can change data | View Programs | 1 |
| View Proposals | Read-only | View Activities, View Programs | 5 |
| Edit Proposals | Can change data | View Proposals, View Activities, Look Up PM Reference Data | 2 |
| Content Planning | Can change data | View Activities, Look Up PM Users, Groups & Roles | 13 |
| Calendar Management | Can change data | View Activities, Look Up PM Users, Groups & Roles | 4 |
| View Projects | Read-only | View Activities | 9 |
| Manage a Project | Can change data | View Projects, View Activities, Look Up PM Reference Data, Look Up PM Users, Groups & Roles | 8 |
| View Work Requests | Read-only | Look Up PM Reference Data, Look Up PM Users, Groups & Roles | 9 |
View Activities
Read-only · 8 tools · Group ID view-activities
Needs: Look Up PM Reference Data
| Tool | What it does |
|---|---|
get_activity | Returns a single Activity (marketing campaign) by its integer ID from Aprimo Marketing Operations. |
get_activity_for_attachment | Returns the Activities (marketing campaign) an attachment belongs to, by the attachment's integer ID, in Aprimo Marketing Operations. |
get_activity_role | Returns a single activity role, including its resolved member users and user tokens, in Aprimo Marketing Operations. |
get_associated_activities | Returns the Activities (marketing campaigns) associated with a DAM record, by the record's ID, in Aprimo Marketing Operations. |
list_activities | Lists Activities (marketing campaigns) in Aprimo Marketing Operations, paged and unfiltered. |
list_activity_roles | Lists the roles assigned to an activity, by the activity's integer ID, in Aprimo Marketing Operations. |
list_recent_activities | Lists Activities (marketing campaigns) recently accessed by the current user, in Aprimo Marketing Operations. |
search_activities | Searches Activities (marketing campaigns) in Aprimo Marketing Operations. |
get_activity
Returns a single Activity (marketing campaign) by its integer ID from Aprimo Marketing Operations. If this tenant renamed the Activity object (e.g. 'Plan', 'Campaign', 'Initiative'), this is still the right tool. Use for Activities/campaigns — not Projects (use get_project for those). Returns only the base Activity record itself — not any Activity sub-resource (activity cells, offers, proposals, roles, treatments, forecasts, etc.), each of which has its own get_activity_* tool. Resolves type, status, timezone, and owner/administrator to human-readable labels/names and includes a clickable deep link.
Response format: the markdown block is pre-rendered with the tenant's own terminology, locale-formatted dates, and resolved labels, and is intended to be displayed verbatim, including every (id: N) suffix and the deep-link heading.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
title | string (optional) | |
description | string (optional) | |
activityTypeId | integer (optional) | |
activityTypeLabel | string (optional) | |
activityStateId | integer (optional) | |
activityStateLabel | string (optional) | |
timeZoneId | integer (optional) | |
timeZoneLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
projectAnchorDate | string (optional) | |
ownerId | integer (optional) | |
ownerName | string (optional) | |
administratorId | integer (optional) | |
administratorName | string (optional) | |
creatorId | integer (optional) | The user who created the activity. New field surfaced now that PM's OpenAPI snapshot documents the Activity schema in full -- no existing resolver maps it to a name, so it stays a raw id. |
modifiedDate | string (optional) | The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ). |
proposalId | integer (optional) | The activity proposal this activity was created from, if any. |
deepLink | string (optional) |
get_activity_for_attachment
Returns the Activities (marketing campaign) an attachment belongs to, by the attachment's integer ID, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
attachmentId | string | Yes | The attachment's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) |
get_activity_role
Returns a single activity role, including its resolved member users and user tokens, in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
roleId | string | Yes | The role's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
roleName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including its member/user-token list under whatever field name PM actually uses -- for full fidelity beyond the defensively-extracted fields above. |
get_associated_activities
Returns the Activities (marketing campaigns) associated with a DAM record, by the record's ID, in Aprimo Marketing Operations. Any recognizable activity entries are returned as resolved items with deep links; the raw response is preserved for shapes the parser doesn't recognize.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
adamRecordId | string | Yes | The DAM record ID the activities are associated with. |
Returns:
| Field | Type | Description |
|---|---|---|
adamRecordId | string (optional) | |
count | integer | |
items | array of ActivityProjection | |
items[].activityId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].activityTypeId | integer (optional) | |
items[].activityTypeLabel | string (optional) | |
items[].activityStateId | integer (optional) | |
items[].activityStateLabel | string (optional) | |
items[].timeZoneId | integer (optional) | |
items[].timeZoneLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].projectAnchorDate | string (optional) | |
items[].ownerId | integer (optional) | |
items[].ownerName | string (optional) | |
items[].administratorId | integer (optional) | |
items[].administratorName | string (optional) | |
items[].creatorId | integer (optional) | The user who created the activity. New field surfaced now that PM's OpenAPI snapshot documents the Activity schema in full -- no existing resolver maps it to a name, so it stays a raw id. |
items[].modifiedDate | string (optional) | The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ). |
items[].proposalId | integer (optional) | The activity proposal this activity was created from, if any. |
items[].deepLink | string (optional) | |
raw | object (optional) |
list_activities
Lists Activities (marketing campaigns) in Aprimo Marketing Operations, paged and unfiltered. Use search_activities when you need to filter by name, type, status, owner, or extended attributes; use this to browse all Activities. Returns totals and human-readable labels for type, status, timezone, and owner/administrator.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes and deep-link headings.
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 ActivityProjection | The items returned in this response. |
items[].activityId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].activityTypeId | integer (optional) | |
items[].activityTypeLabel | string (optional) | |
items[].activityStateId | integer (optional) | |
items[].activityStateLabel | string (optional) | |
items[].timeZoneId | integer (optional) | |
items[].timeZoneLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].projectAnchorDate | string (optional) | |
items[].ownerId | integer (optional) | |
items[].ownerName | string (optional) | |
items[].administratorId | integer (optional) | |
items[].administratorName | string (optional) | |
items[].creatorId | integer (optional) | The user who created the activity. New field surfaced now that PM's OpenAPI snapshot documents the Activity schema in full -- no existing resolver maps it to a name, so it stays a raw id. |
items[].modifiedDate | string (optional) | The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ). |
items[].proposalId | integer (optional) | The activity proposal this activity was created from, if any. |
items[].deepLink | string (optional) |
list_activity_roles
Lists the roles assigned to an activity, by the activity's integer ID, in Aprimo Marketing Operations. Each role's member users and user tokens are resolved.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_recent_activities
Lists Activities (marketing campaigns) recently accessed by the current user, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
search_activities
Searches Activities (marketing campaigns) in Aprimo Marketing Operations. If this tenant has renamed the Activity object (e.g. to 'Plan', 'Campaign', 'Initiative'), users will mention it by this tenant's term — use this tool whenever the user means Activities, regardless of the word they say. Returns a paged list with totals and human-readable labels for Activity type, status, timezone, and owner/administrator names. Use this tool for Activities/campaigns — not for Projects (use search_projects for those).
Response format. Each item comes back as a markdown block pre-rendered server-side using the tenant's own terminology: labels reflect tenant configuration, dates are locale-formatted, lookup values are resolved to display strings, and the heading is a clickable deep link. The block is intended to be displayed verbatim rather than re-rendered from the structured payload, since the markdown already carries the tenant's vocabulary. If you do re-render it, preserve the tenant-localized labels, the (id: N) suffixes (which enable follow-up filters), the date formatting, and the deep-link heading.
Filtering. Prefer the name-keyed filter parameters (activityTypeLabel, activityStateLabel, ownerName, administratorName) over composing the query DSL. For extended attributes — tenant-configured custom fields beyond the standard set, such as 'Phase Gate' or 'Region' — use attributeFilters to match a specific value, and attributesPresent to match any value or no value. Extended attributes cannot be addressed through query, because the server does not expose their underlying field slugs; pass the display name as written.
Query DSL. query takes a structured operator tree using PascalCase FieldName/FieldValue. By partial name: query='{"contains":{"FieldName":"Name","FieldValue":"launch"}}'. By id: query='{"equals":{"FieldName":"ActivityId","FieldValue":13801}}'. To browse without a filter use list_activities 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. 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 PM's wire field name ('ActivityId', 'Name', 'OwnerId', 'ActivityStateId', etc.) and FieldValue is a native JSON value matching the field's type (integer for IDs, ISO 8601 string for dates, string for text). 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_activities to browse without a filter. For status/type/owner/administrator filtering, prefer the name-keyed parameters below instead — they're simpler. Use query for ID lookups, partial-name searches on Name, date range filters, or compound filters. Date field names (two date fields share confusing wire names — use exactly these): 'VisualEndDate' = the user-visible End Date (what users mean when they say 'end date'); 'EndDate' = the Project Anchor Date (what users mean when they say 'project anchor date', 'Project anchor date', or 'anchor date' — the word 'Project' in that label is this tenant's term for the project object). Examples: by id '{"equals":{"FieldName":"ActivityId","FieldValue":13801}}'; by name (partial) '{"contains":{"FieldName":"Name","FieldValue":"launch"}}'; by end date '{"lessthan":{"FieldName":"VisualEndDate","FieldValue":"2026-07-01"}}'; by anchor date '{"equals":{"FieldName":"EndDate","FieldValue":"2026-06-15"}}'; compound '{"and":[{"equals":{"FieldName":"OwnerId","FieldValue":998}},{"contains":{"FieldName":"Name","FieldValue":"Q4"}}]}'. |
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. |
activityTypeLabel | string | No | Filter to activities with this activity type (label, case-insensitive, e.g. 'Initiative'). Resolved against the PM ActivityType lookup list. Returns an error if the label doesn't match any known activity type. Combined with query and other filters via and. |
activityStateLabel | string | No | Filter to activities in this state (label, case-insensitive, e.g. 'Active'). Resolved against the PM ActivityTypeStatus lookup list. Returns an error if the label doesn't match any known state. Combined with query and other filters via and. |
ownerName | string | No | Filter to activities owned by users whose first or last name matches this string (case-insensitive substring). Examples: 'Alice', 'Adams', 'alice ad'. If multiple users match, all are included (or). If no users match, returns an empty result set with a message — not an error. |
administratorName | string | No | Filter to activities whose administrator's first or last name matches this string (case-insensitive substring). Same matching semantics as ownerName. |
attributeFilters | object (map of string) | No | Filter by extended attributes with a specific value. Tenant-configured custom fields beyond the standard set. Pass a dictionary keyed by the attribute's display name exactly as the user/admin sees it (e.g. 'Phase Gate', 'Act Multi Select', 'Region'), with the desired value as a string. For lookup-type EAs (picklists), pass the option's display label — the server translates to the underlying itemId. For text/number/date EAs, pass the value as a string — the server passes it through. Returns BadRequest with the valid attribute set if a key doesn't match any EA. Returns BadRequest with the valid value set if a value doesn't match any option for a lookup EA. Combined with query and other filters via and. |
attributesPresent | object (map of boolean) | No | Filter by extended attribute presence — for natural-language patterns like 'activities with any value for Act Multi Select' or 'activities missing a Phase Gate tag'. Pass a dictionary keyed by the attribute's display name, with a boolean value: True = the EA has any value (PM operator isnotnull); False = the EA has no value (isnull). Use this when the user does not specify a particular value to match. Returns BadRequest if a key doesn't match any EA. Combined with other filters 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 ActivityProjection | The items returned in this response. |
items[].activityId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].activityTypeId | integer (optional) | |
items[].activityTypeLabel | string (optional) | |
items[].activityStateId | integer (optional) | |
items[].activityStateLabel | string (optional) | |
items[].timeZoneId | integer (optional) | |
items[].timeZoneLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].projectAnchorDate | string (optional) | |
items[].ownerId | integer (optional) | |
items[].ownerName | string (optional) | |
items[].administratorId | integer (optional) | |
items[].administratorName | string (optional) | |
items[].creatorId | integer (optional) | The user who created the activity. New field surfaced now that PM's OpenAPI snapshot documents the Activity schema in full -- no existing resolver maps it to a name, so it stays a raw id. |
items[].modifiedDate | string (optional) | The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ). |
items[].proposalId | integer (optional) | The activity proposal this activity was created from, if any. |
items[].deepLink | string (optional) |
Edit Activities
Can change data · 9 tools (8 currently available) · Group ID edit-activities
Needs: View Activities, Look Up PM Reference Data, Look Up PM Users, Groups & Roles
| Tool | What it does |
|---|---|
add_activity_role_members | Adds one or more user or user-token members to an activity role, merging with existing members and skipping duplicates, in Aprimo Marketing Operations. |
create_activity | Creates a new Activity (marketing campaign) in Aprimo Marketing Operations. |
create_activity_milestone | Not currently available. Creates a milestone under an Activity (marketing campaign), by the parent activity's integer ID, in Aprimo Marketing Operations. |
create_activity_role | Creates a role on an activity from the supplied user role and members, in Aprimo Marketing Operations. |
delete_activity | Destructive. Permanently deletes an Activity (marketing campaign) by its integer ID in Aprimo Marketing Operations. |
delete_activity_role | Destructive. Permanently deletes a role from an activity in Aprimo Marketing Operations. |
remove_activity_role_member | Destructive. Permanently removes a single member from an activity role in Aprimo Marketing Operations. |
update_activity | Updates an existing Activity (marketing campaign) by its integer ID in Aprimo Marketing Operations. |
update_activity_role | Replaces an activity role's user role and member set with the supplied values, in Aprimo Marketing Operations. |
add_activity_role_members
Adds one or more user or user-token members to an activity role, merging with existing members and skipping duplicates, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact members being added. Returns the updated role.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
roleId | string | Yes | The role's integer ID. |
body | string | Yes | JSON object with the members to add (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) | |
roleName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including its member/user-token list under whatever field name PM actually uses -- for full fidelity beyond the defensively-extracted fields above. |
create_activity
Creates a new Activity (marketing campaign) in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload (title, dates, type, owner, etc.). Returns the created Activity with resolved labels and a deep link.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new activity's fields (PM wire names, e.g. {"name":"Q4 Launch","activityTypeId":7,"beginDate":"2026-01-15T00:00:00Z"}). Pass PM's wire field names; the server sends the object as-is. |
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 exact payload. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
title | string (optional) | |
description | string (optional) | |
activityTypeId | integer (optional) | |
activityTypeLabel | string (optional) | |
activityStateId | integer (optional) | |
activityStateLabel | string (optional) | |
timeZoneId | integer (optional) | |
timeZoneLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
projectAnchorDate | string (optional) | |
ownerId | integer (optional) | |
ownerName | string (optional) | |
administratorId | integer (optional) | |
administratorName | string (optional) | |
creatorId | integer (optional) | The user who created the activity. New field surfaced now that PM's OpenAPI snapshot documents the Activity schema in full -- no existing resolver maps it to a name, so it stays a raw id. |
modifiedDate | string (optional) | The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ). |
proposalId | integer (optional) | The activity proposal this activity was created from, if any. |
deepLink | string (optional) |
create_activity_milestone
Not currently available
Creates a milestone under an Activity (marketing campaign), by the parent activity's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created milestone (PM's ActivityDates schema -- a distinct resource from the parent activity).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The parent activity's integer ID. |
body | string | Yes | JSON object with the milestone's fields (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 |
|---|---|---|
activityDateId | integer | |
activityId | integer | |
title | string (optional) | |
description | string (optional) | |
startDate | string (optional) | |
endDate | string (optional) | |
scheduleType | integer (optional) | |
timeZone | integer (optional) | |
milestoneEaId | integer (optional) | |
raw | object (optional) | The full raw wire object, always included -- some fields the documented schema declares as present (activityDateId/activityId/startDate) have been observed absent on a real, successful create, so this is never asserted as fact beyond what's extracted above. |
create_activity_role
Creates a role on an activity from the supplied user role and members, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created role.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
body | string | Yes | JSON object with the new role's data (PM wire names), including the user role and its members. |
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) | |
roleName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including its member/user-token list under whatever field name PM actually uses -- for full fidelity beyond the defensively-extracted fields above. |
delete_activity
Destructive
Permanently deletes an Activity (marketing campaign) by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact Activity with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID to delete. |
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 confirmed the exact activity. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting an activity is permanent and cannot be undone. Set only after stating the exact activity to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
delete_activity_role
Destructive
Permanently deletes a role from an activity in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact role with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
roleId | string | Yes | The role's integer ID to delete. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a role is permanent and cannot be undone. Set only after stating the exact role to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
roleId | integer | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
remove_activity_role_member
Destructive
Permanently removes a single member from an activity role in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact member with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
roleId | string | Yes | The role's integer ID. |
memberId | string | Yes | The member's integer ID to remove. |
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) — removing a member is permanent and cannot be undone. Set only after stating the exact member to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer | |
roleId | integer | |
memberId | integer | |
removed | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
update_activity
Updates an existing Activity (marketing campaign) by its integer 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 Activity.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity'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 |
|---|---|---|
activityId | integer | |
title | string (optional) | |
description | string (optional) | |
activityTypeId | integer (optional) | |
activityTypeLabel | string (optional) | |
activityStateId | integer (optional) | |
activityStateLabel | string (optional) | |
timeZoneId | integer (optional) | |
timeZoneLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
projectAnchorDate | string (optional) | |
ownerId | integer (optional) | |
ownerName | string (optional) | |
administratorId | integer (optional) | |
administratorName | string (optional) | |
creatorId | integer (optional) | The user who created the activity. New field surfaced now that PM's OpenAPI snapshot documents the Activity schema in full -- no existing resolver maps it to a name, so it stays a raw id. |
modifiedDate | string (optional) | The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ). |
proposalId | integer (optional) | The activity proposal this activity was created from, if any. |
deepLink | string (optional) |
update_activity_role
Replaces an activity role's user role and member set with the supplied values, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact changes. Returns the updated role.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
roleId | string | Yes | The role's integer ID to update. |
body | string | Yes | JSON object with the full replacement role data (PM wire names), including the user role and its members. |
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 |
|---|---|---|
id | string (optional) | |
roleName | string (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including its member/user-token list under whatever field name PM actually uses -- for full fidelity beyond the defensively-extracted fields above. |
View Programs
Read-only · 3 tools · Group ID view-programs
Needs: View Activities
| Tool | What it does |
|---|---|
get_program | Returns a single program by its integer ID in Aprimo Marketing Operations. |
get_programs_for_activity | Returns the programs associated with an activity, by the activity's integer ID, in Aprimo Marketing Operations, paged. |
list_programs | Lists programs in Aprimo Marketing Operations, paged and unfiltered. |
get_program
Returns a single program by its integer ID in Aprimo Marketing Operations. Not its proposal (use get_program_proposal for that).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Alternatively, identify the program by name instead of programId. Note: resolving by name scans the full program list, which may be slower than by id for large tenants.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
programId | string | No | The program's integer ID. Provide either programId or name, not both. |
name | string | No | The program's name. Provide either programId or name, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
programId | integer | |
title | string (optional) | PM's real wire field for this is title, not name -- see the class remarks. |
ownerId | integer (optional) | |
description | string (optional) | |
startDate | string (optional) | |
endDate | string (optional) | |
programTypeId | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (optional) | |
clientId | integer (optional) | |
brandId | integer (optional) | |
classificationId | integer (optional) | |
raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
get_programs_for_activity
Returns the programs associated with an activity, by the activity's integer ID, in Aprimo Marketing Operations, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
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 ProgramProjection | The items returned in this response. |
items[].programId | integer | |
items[].title | string (optional) | PM's real wire field for this is title, not name -- see the class remarks. |
items[].ownerId | integer (optional) | |
items[].description | string (optional) | |
items[].startDate | string (optional) | |
items[].endDate | string (optional) | |
items[].programTypeId | integer (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].clientId | integer (optional) | |
items[].brandId | integer (optional) | |
items[].classificationId | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
list_programs
Lists programs in Aprimo Marketing Operations, paged and unfiltered.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
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. 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 ProgramProjection | The items returned in this response. |
items[].programId | integer | |
items[].title | string (optional) | PM's real wire field for this is title, not name -- see the class remarks. |
items[].ownerId | integer (optional) | |
items[].description | string (optional) | |
items[].startDate | string (optional) | |
items[].endDate | string (optional) | |
items[].programTypeId | integer (optional) | |
items[].modifiedUser | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].clientId | integer (optional) | |
items[].brandId | integer (optional) | |
items[].classificationId | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
Edit Programs
Can change data · 1 tool · Group ID edit-programs
Needs: View Programs
| Tool | What it does |
|---|---|
update_program | Updates an existing program by its integer ID in Aprimo Marketing Operations. |
update_program
Updates an existing program by its integer 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 program. Alternatively, identify the program by name instead of programId. Note: resolving by name scans the full program list, which may be slower than by id for large tenants.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
programId | string | No | The program's integer ID. Provide either programId or name, not both. |
name | string | No | The program's name. Provide either programId or name, not both. |
body | string | No | 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 |
|---|---|---|
programId | integer | |
title | string (optional) | PM's real wire field for this is title, not name -- see the class remarks. |
ownerId | integer (optional) | |
description | string (optional) | |
startDate | string (optional) | |
endDate | string (optional) | |
programTypeId | integer (optional) | |
modifiedUser | integer (optional) | |
modifiedDate | string (optional) | |
clientId | integer (optional) | |
brandId | integer (optional) | |
classificationId | integer (optional) | |
raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
View Proposals
Read-only · 5 tools (4 currently available) · Group ID view-proposals
Needs: View Activities, View Programs
| Tool | What it does |
|---|---|
get_activity_proposal | Returns a single activity proposal by its integer ID in Aprimo Marketing Operations. |
get_program_proposal | Not currently available. Returns a single program proposal by its integer ID in Aprimo Marketing Operations. |
list_activity_proposal_templates | Lists activity proposal templates in Aprimo Marketing Operations, paged. |
search_activity_proposals | Searches activity proposals in Aprimo Marketing Operations by title, paged. |
search_program_proposals | Searches program proposals in Aprimo Marketing Operations by title, paged. |
get_activity_proposal
Returns a single activity proposal by its integer ID in Aprimo Marketing Operations. Not its forecasts (use get_activity_proposal_forecasts for those). Resolves activity type/timezone labels and owner/administrator names.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
proposalId | string | Yes | The activity proposal's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
proposalId | integer | |
title | string (optional) | |
description | string (optional) | |
proposalStateId | integer (optional) | PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. |
activityTypeId | integer (optional) | |
activityTypeLabel | string (optional) | |
ownerId | integer (optional) | |
ownerName | string (optional) | |
administratorId | integer (optional) | |
administratorName | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
anchorDate | string (optional) | |
timeZoneId | integer (optional) | |
timeZoneLabel | string (optional) | |
classificationId | integer (optional) | Raw id, no existing lookup-list resolver for classifications. |
currencyCode | integer (optional) | Raw id, no existing lookup-list resolver for currency codes. |
isTemplate | boolean (optional) | |
totalCost | number (optional) | |
submitDate | string (optional) | The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
modifiedDate | string (optional) | The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
programId | integer (optional) | The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
get_program_proposal
Not currently available
Returns a single program proposal by its integer ID in Aprimo Marketing Operations. Resolves owner/modified-by user names.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
proposalId | string | Yes | The program proposal's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
proposalId | integer | |
title | string (optional) | |
description | string (optional) | |
classificationId | integer (optional) | Raw id, no existing lookup-list resolver for classifications. |
proposalState | integer (optional) | PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: proposalState. |
programTypeId | integer (optional) | Raw id, no existing lookup-list resolver for program types. |
ownerId | integer (optional) | |
ownerName | string (optional) | Not part of the wire schema -- filled by PmProgramProposalMapper.ResolveAsync. |
beginDate | string (optional) | |
endDate | string (optional) | |
modifiedDate | string (optional) | |
modifiedUser | integer (optional) | Wire field: modifiedUser. |
modifiedByName | string (optional) | Not part of the wire schema -- filled by PmProgramProposalMapper.ResolveAsync. |
currencyCode | integer (optional) | Raw id, no existing lookup-list resolver for currency codes. |
submitDate | string (optional) | |
invoiceTotal | number (optional) | |
materialTotal | number (optional) | |
laborTotal | number (optional) | |
tAndETotal | number (optional) | |
totalCost | number (optional) | |
approvalType | integer (optional) | PM's ApprovalType enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: approvalType. |
objective | string (optional) | |
proposalType | integer (optional) | PM's ProposalType enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: proposalType. |
raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
list_activity_proposal_templates
Lists activity proposal templates in Aprimo Marketing Operations, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
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. 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 ActivityProposalProjection | The items returned in this response. |
items[].proposalId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].proposalStateId | integer (optional) | PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. |
items[].activityTypeId | integer (optional) | |
items[].activityTypeLabel | string (optional) | |
items[].ownerId | integer (optional) | |
items[].ownerName | string (optional) | |
items[].administratorId | integer (optional) | |
items[].administratorName | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].anchorDate | string (optional) | |
items[].timeZoneId | integer (optional) | |
items[].timeZoneLabel | string (optional) | |
items[].classificationId | integer (optional) | Raw id, no existing lookup-list resolver for classifications. |
items[].currencyCode | integer (optional) | Raw id, no existing lookup-list resolver for currency codes. |
items[].isTemplate | boolean (optional) | |
items[].totalCost | number (optional) | |
items[].submitDate | string (optional) | The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
items[].modifiedDate | string (optional) | The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
items[].programId | integer (optional) | The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
items[].raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
search_activity_proposals
Searches activity proposals in Aprimo Marketing Operations by title, paged. A titleFilter is required -- PM has no match-all query for this endpoint.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
titleFilter | string | No | Required case-insensitive substring filter on the proposal's title -- PM has no match-all query for this endpoint, so this cannot be omitted. |
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 ActivityProposalProjection | The items returned in this response. |
items[].proposalId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].proposalStateId | integer (optional) | PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. |
items[].activityTypeId | integer (optional) | |
items[].activityTypeLabel | string (optional) | |
items[].ownerId | integer (optional) | |
items[].ownerName | string (optional) | |
items[].administratorId | integer (optional) | |
items[].administratorName | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].anchorDate | string (optional) | |
items[].timeZoneId | integer (optional) | |
items[].timeZoneLabel | string (optional) | |
items[].classificationId | integer (optional) | Raw id, no existing lookup-list resolver for classifications. |
items[].currencyCode | integer (optional) | Raw id, no existing lookup-list resolver for currency codes. |
items[].isTemplate | boolean (optional) | |
items[].totalCost | number (optional) | |
items[].submitDate | string (optional) | The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
items[].modifiedDate | string (optional) | The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
items[].programId | integer (optional) | The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
items[].raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
search_program_proposals
Searches program proposals in Aprimo Marketing Operations by title, paged. A titleFilter is required -- PM has no match-all query for this endpoint.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
titleFilter | string | Yes | Required case-insensitive substring filter on the proposal's title -- PM has no match-all query for this endpoint, so this cannot be omitted. |
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 ProgramProposalProjection | The items returned in this response. |
items[].proposalId | integer | |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].classificationId | integer (optional) | Raw id, no existing lookup-list resolver for classifications. |
items[].proposalState | integer (optional) | PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: proposalState. |
items[].programTypeId | integer (optional) | Raw id, no existing lookup-list resolver for program types. |
items[].ownerId | integer (optional) | |
items[].ownerName | string (optional) | Not part of the wire schema -- filled by PmProgramProposalMapper.ResolveAsync. |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].modifiedDate | string (optional) | |
items[].modifiedUser | integer (optional) | Wire field: modifiedUser. |
items[].modifiedByName | string (optional) | Not part of the wire schema -- filled by PmProgramProposalMapper.ResolveAsync. |
items[].currencyCode | integer (optional) | Raw id, no existing lookup-list resolver for currency codes. |
items[].submitDate | string (optional) | |
items[].invoiceTotal | number (optional) | |
items[].materialTotal | number (optional) | |
items[].laborTotal | number (optional) | |
items[].tAndETotal | number (optional) | |
items[].totalCost | number (optional) | |
items[].approvalType | integer (optional) | PM's ApprovalType enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: approvalType. |
items[].objective | string (optional) | |
items[].proposalType | integer (optional) | PM's ProposalType enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: proposalType. |
items[].raw | object (optional) | The complete wire object, verbatim (set by the mapper). See the class remarks. |
Edit Proposals
Can change data · 2 tools · Group ID edit-proposals
Needs: View Proposals, View Activities, Look Up PM Reference Data
| Tool | What it does |
|---|---|
create_activity_proposal | Creates a new activity proposal in Aprimo Marketing Operations. |
update_activity_proposal | Updates an existing activity proposal by its integer ID in Aprimo Marketing Operations. |
create_activity_proposal
Creates a new activity proposal in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created activity proposal.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new activity proposal's data (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 |
|---|---|---|
proposalId | integer | |
title | string (optional) | |
description | string (optional) | |
proposalStateId | integer (optional) | PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. |
activityTypeId | integer (optional) | |
activityTypeLabel | string (optional) | |
ownerId | integer (optional) | |
ownerName | string (optional) | |
administratorId | integer (optional) | |
administratorName | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
anchorDate | string (optional) | |
timeZoneId | integer (optional) | |
timeZoneLabel | string (optional) | |
classificationId | integer (optional) | Raw id, no existing lookup-list resolver for classifications. |
currencyCode | integer (optional) | Raw id, no existing lookup-list resolver for currency codes. |
isTemplate | boolean (optional) | |
totalCost | number (optional) | |
submitDate | string (optional) | The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
modifiedDate | string (optional) | The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
programId | integer (optional) | The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
update_activity_proposal
Updates an existing activity proposal by its integer 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 activity proposal.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
proposalId | string | Yes | The activity proposal'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 |
|---|---|---|
proposalId | integer | |
title | string (optional) | |
description | string (optional) | |
proposalStateId | integer (optional) | PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. |
activityTypeId | integer (optional) | |
activityTypeLabel | string (optional) | |
ownerId | integer (optional) | |
ownerName | string (optional) | |
administratorId | integer (optional) | |
administratorName | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
anchorDate | string (optional) | |
timeZoneId | integer (optional) | |
timeZoneLabel | string (optional) | |
classificationId | integer (optional) | Raw id, no existing lookup-list resolver for classifications. |
currencyCode | integer (optional) | Raw id, no existing lookup-list resolver for currency codes. |
isTemplate | boolean (optional) | |
totalCost | number (optional) | |
submitDate | string (optional) | The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
modifiedDate | string (optional) | The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
programId | integer (optional) | The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema. |
raw | object (optional) | The complete wire object, verbatim. See the class remarks. |
Content Planning
Can change data · 13 tools · Group ID content-planning
Needs: View Activities, Look Up PM Users, Groups & Roles
| Tool | What it does |
|---|---|
associate_content_plan_activities | Associates the specified activities with a content plan, by the plan's integer ID, in Aprimo Marketing Operations. |
create_content_plan_collection | Creates and links a new DAM collection for a content plan, by the plan's integer ID, in Aprimo Marketing Operations. |
delete_content_plan | Destructive. Permanently deletes a content plan by its integer ID in Aprimo Marketing Operations. |
get_content_plan | Returns a single content plan by its integer ID in Aprimo Marketing Operations. |
get_content_plan_activity_progress | Returns the activity progress for a content plan, by its integer ID, in Aprimo Marketing Operations. |
get_content_plan_manage_activities | Lists the activities available to manage/associate for a content plan, by its integer ID, in Aprimo Marketing Operations, paged. |
list_content_plans | Lists content plans in Aprimo Marketing Operations, paged and unfiltered. |
notify_content_plan_activity_owners | Notifies the owners of the specified activities on a content plan, by the plan's integer ID, in Aprimo Marketing Operations. |
remove_content_plan_activity | Destructive. Removes the association between a content plan and the specified activities, by the plan's integer ID, in Aprimo Marketing Operations. |
share_content_plan | Shares a content plan with the specified users/groups, by the plan's integer ID, in Aprimo Marketing Operations. |
unlink_content_plan_collection | Destructive. Unlinks a DAM collection from a content plan, by the plan's integer ID and the collection's GUID, in Aprimo Marketing Operations. |
update_content_plan | Updates an existing content plan by its integer ID in Aprimo Marketing Operations. |
update_content_plan_collection | Updates the DAM collection linked to a content plan, by the plan's integer ID, in Aprimo Marketing Operations. |
associate_content_plan_activities
Associates the specified activities with a content plan, by the plan's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact activity list. Returns the activity ids associated.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
activityIds | string | Yes | JSON array of the activities' integer IDs to associate, e.g. "[13801,13802]". |
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 exact activity list. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
action | string (optional) | "associate", "remove", or "notify-owners". |
activityIds | array of integer |
create_content_plan_collection
Creates and links a new DAM collection for a content plan, by the plan's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created and linked collection.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
body | string | Yes | JSON object with the new DAM collection's data (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 |
|---|---|---|
planId | integer | |
collectionId | string (optional) | |
collectionType | integer (optional) |
delete_content_plan
Destructive
Permanently deletes a content plan by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact content plan with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID to delete. |
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 confirmed the exact content plan. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a content plan is permanent and cannot be undone. Set only after stating the exact content plan to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_content_plan
Returns a single content plan by its integer ID in Aprimo Marketing Operations. Not its activity progress (use get_content_plan_activity_progress) or its manage-activities view (use get_content_plan_manage_activities). Resolves status/type labels and administrator/modified-by names.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
scsId | integer (optional) | PM's internal scs id for this content plan. New field surfaced now that PM's snapshot documents the full ContentPlan schema. |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | [StaticLookupList] field resolved via PmFieldLabelCache (inlined on /metadata/ContentPlan), same mechanism as . |
statusLabel | string (optional) | |
typeId | integer (optional) | [StaticLookupList] field, same resolution mechanism as . |
typeLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
administratorId | integer (optional) | |
administratorName | string (optional) | |
modifiedUserId | integer (optional) | |
modifiedUserName | string (optional) | |
modifiedDate | string (optional) | |
backgroundTheme | string (optional) | |
canRead | boolean (optional) | |
canModify | boolean (optional) | |
canCreateActivity | boolean (optional) | |
canModifyActivity | boolean (optional) | |
collections | array of ContentPlanCollection (optional) | DAM collections linked to this content plan. Null when the wire object carried none. |
collections[].planId | integer (optional) | |
collections[].collectionId | string (optional) | The linked DAM collection's GUID id. |
collections[].collectionType | integer (optional) |
get_content_plan_activity_progress
Returns the activity progress for a content plan, by its integer ID, in Aprimo Marketing Operations. Recognized activity-id-keyed entries are resolved with their names and deep links; the raw response is preserved for shapes the parser doesn't recognize.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
count | integer | |
items | array of ContentPlanActivityProgressEntry | |
items[].activityId | integer | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].progress | object (optional) | The per-activity progress payload, verbatim (shape not stabilized upstream). |
raw | object (optional) | Preserved untouched when the body couldn't be recognized as an activity-id-keyed object. |
get_content_plan_manage_activities
Lists the activities available to manage/associate for a content plan, by its integer ID, in Aprimo Marketing Operations, paged. Resolves activity type/state labels and owner names.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
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 ContentPlanManageActivityItem | The items returned in this response. |
items[].scsId | integer (optional) | |
items[].name | string (optional) | |
items[].beginDate | string (optional) | No corresponding field in PM's manage-activities item schema -- always null (see the class remarks). |
items[].endDate | string (optional) | |
items[].ownerId | integer (optional) | |
items[].ownerName | string (optional) | |
items[].administratorId | integer (optional) | |
items[].administratorName | string (optional) | |
items[].activityTypeId | integer (optional) | |
items[].activityTypeLabel | string (optional) | |
items[].activityStateId | integer (optional) | No corresponding field in PM's manage-activities item schema -- always null (see the class remarks). |
items[].activityStateLabel | string (optional) |
list_content_plans
Lists content plans in Aprimo Marketing Operations, paged and unfiltered. Returns status/type labels and administrator/modified-by names. Note: PM does not report a total record count for this endpoint -- re-call with an increased offset while a full page keeps coming back.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes.
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. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
offset | integer | |
items | array of ContentPlanProjection | |
items[].planId | integer | |
items[].scsId | integer (optional) | PM's internal scs id for this content plan. New field surfaced now that PM's snapshot documents the full ContentPlan schema. |
items[].title | string (optional) | |
items[].description | string (optional) | |
items[].statusId | integer (optional) | [StaticLookupList] field resolved via PmFieldLabelCache (inlined on /metadata/ContentPlan), same mechanism as . |
items[].statusLabel | string (optional) | |
items[].typeId | integer (optional) | [StaticLookupList] field, same resolution mechanism as . |
items[].typeLabel | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].administratorId | integer (optional) | |
items[].administratorName | string (optional) | |
items[].modifiedUserId | integer (optional) | |
items[].modifiedUserName | string (optional) | |
items[].modifiedDate | string (optional) | |
items[].backgroundTheme | string (optional) | |
items[].canRead | boolean (optional) | |
items[].canModify | boolean (optional) | |
items[].canCreateActivity | boolean (optional) | |
items[].canModifyActivity | boolean (optional) | |
items[].collections | array of ContentPlanCollection (optional) | DAM collections linked to this content plan. Null when the wire object carried none. |
items[].collections[].planId | integer (optional) | |
items[].collections[].collectionId | string (optional) | The linked DAM collection's GUID id. |
items[].collections[].collectionType | integer (optional) |
notify_content_plan_activity_owners
Notifies the owners of the specified activities on a content plan, by the plan's integer ID, in Aprimo Marketing Operations. Sends notification emails -- not a data mutation, but still an external side effect. Requires confirmed=true after showing the user the exact activity list. Returns the activity ids notified.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
activityIds | string | Yes | JSON array of the activities' integer IDs whose owners should be notified, e.g. "[13801,13802]". |
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 sending these notifications. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
action | string (optional) | "associate", "remove", or "notify-owners". |
activityIds | array of integer |
remove_content_plan_activity
Destructive
Removes the association between a content plan and the specified activities, by the plan's integer ID, in Aprimo Marketing Operations. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact activity list with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
activityIds | string | Yes | JSON array of the activities' integer IDs to disassociate, e.g. "[13801,13802]". |
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) — removing the association is not easily undone. Set only after stating the exact activity list to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
action | string (optional) | "associate", "remove", or "notify-owners". |
activityIds | array of integer |
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.
share_content_plan
Shares a content plan with the specified users/groups, by the plan's integer ID, in Aprimo Marketing Operations. Replaces the plan's entire access list with exactly the entries provided -- it does not merge/add to the existing list. Confirmed live: any existing grantee omitted from entries Loses access. Fetch the plan's current access list first (get_content_plan) and include every entry you want to keep, plus any new ones. Requires confirmed=true after showing the user the exact grant list. Returns the resulting access-list entries.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
entries | string | Yes | JSON array of access-list entries to grant -- replaces the entire existing access list. Each entry requires "objectId" (must equal contentPlanId), "userId", and "hasEditRight" (0 or 1) -- "objectId" is easy to omit but PM rejects the whole call without it. e.g. "[{"objectId":1042,"userId":7,"hasEditRight":1}]". |
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 exact grant list. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
count | integer | |
items | array of ContentPlanAccessEntry | |
items[].objectId | integer (optional) | |
items[].userId | integer (optional) | |
items[].userName | string (optional) | |
items[].hasEditRight | boolean (optional) |
unlink_content_plan_collection
Destructive
Unlinks a DAM collection from a content plan, by the plan's integer ID and the collection's GUID, in Aprimo Marketing Operations. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact content plan and collection with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
collectionGuid | string | Yes | The linked DAM collection's GUID. |
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) — unlinking removes the collection's association with this content plan. Set only after stating the exact content plan and collection to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
collectionGuid | string (optional) | |
unlinked | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
update_content_plan
Updates an existing content plan by its integer 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 content plan.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan'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 |
|---|---|---|
planId | integer | |
scsId | integer (optional) | PM's internal scs id for this content plan. New field surfaced now that PM's snapshot documents the full ContentPlan schema. |
title | string (optional) | |
description | string (optional) | |
statusId | integer (optional) | [StaticLookupList] field resolved via PmFieldLabelCache (inlined on /metadata/ContentPlan), same mechanism as . |
statusLabel | string (optional) | |
typeId | integer (optional) | [StaticLookupList] field, same resolution mechanism as . |
typeLabel | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
administratorId | integer (optional) | |
administratorName | string (optional) | |
modifiedUserId | integer (optional) | |
modifiedUserName | string (optional) | |
modifiedDate | string (optional) | |
backgroundTheme | string (optional) | |
canRead | boolean (optional) | |
canModify | boolean (optional) | |
canCreateActivity | boolean (optional) | |
canModifyActivity | boolean (optional) | |
collections | array of ContentPlanCollection (optional) | DAM collections linked to this content plan. Null when the wire object carried none. |
collections[].planId | integer (optional) | |
collections[].collectionId | string (optional) | The linked DAM collection's GUID id. |
collections[].collectionType | integer (optional) |
update_content_plan_collection
Updates the DAM collection linked to a content plan, by the plan's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the linked collection.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
contentPlanId | string | Yes | The content plan's integer ID. |
body | string | Yes | JSON object with the DAM collection mapping data (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 change. |
Returns:
| Field | Type | Description |
|---|---|---|
planId | integer | |
collectionId | string (optional) | |
collectionType | integer (optional) |
Calendar Management
Can change data · 4 tools · Group ID calendar-management
Needs: View Activities, Look Up PM Users, Groups & Roles
| Tool | What it does |
|---|---|
get_calendar_activity_type_colors | Retrieves the configured display colors for each calendar activity type in Aprimo Marketing Operations. |
get_shared_calendar_access | Returns the list of users a calendar is shared with and their access rights in Aprimo Marketing Operations. |
share_calendar | Shares a calendar with a list of users and grants their access rights in Aprimo Marketing Operations. |
update_calendar_activity_type_colors | Updates the display colors assigned to calendar activity types in Aprimo Marketing Operations. |
get_calendar_activity_type_colors
Retrieves the configured display colors for each calendar activity type in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of CalendarActivityTypeColorProjection | |
items[].raw | object (optional) |
get_shared_calendar_access
Returns the list of users a calendar is shared with and their access rights in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
calendarId | string | Yes | The calendar's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of CalendarAccessEntryProjection | |
items[].objectId | integer | |
items[].userId | integer | |
items[].userName | string (optional) | |
items[].hasEditRight | integer | |
items[].avatarUrl | string (optional) |
share_calendar
Shares a calendar with a list of users and grants their access rights in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the resulting access list.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
calendarId | string | Yes | The calendar's integer ID to share. |
body | string | Yes | JSON object with the calendar identifier and the access list entries to apply (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 | |
items | array of CalendarAccessEntryProjection | |
items[].objectId | integer | |
items[].userId | integer | |
items[].userName | string (optional) | |
items[].hasEditRight | integer | |
items[].avatarUrl | string (optional) |
update_calendar_activity_type_colors
Updates the display colors assigned to calendar activity types in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the resulting colors.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the activity type color assignments to apply (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 | |
items | array of CalendarActivityTypeColorProjection | |
items[].raw | object (optional) |
View Projects
Read-only · 9 tools (8 currently available) · Group ID view-projects
Needs: View Activities
| Tool | What it does |
|---|---|
get_project | Returns a single Project by its integer ID from Aprimo Marketing Operations. |
get_project_dam_collection | Not currently available. Returns the DAM collections linked to a Project, by the project's integer ID, in Aprimo Marketing Operations. |
get_project_role_members | Returns the members of a project role, by project ID and project-role ID, in Aprimo Marketing Operations. |
get_project_role_memberships | Returns all role memberships for a project, by the project's integer ID, in Aprimo Marketing Operations. |
get_projects_for_activity | Lists the Projects that belong to an Activity (marketing campaign), by the activity's integer ID, in Aprimo Marketing Operations. |
list_projects | Lists Projects in Aprimo Marketing Operations, paged. |
list_projects_display | Returns a paged, sortable display list of Projects for list/grid presentation in Aprimo Marketing Operations, optionally filtered by project statuses, title, and activity ID. |
list_projects_for_attachment | Lists the Projects that an attachment (by integer ID) is associated with, in Aprimo Marketing Operations, paged and sortable. |
search_projects | Searches Projects in Aprimo Marketing Operations. |
get_project
Returns a single Project by its integer ID from Aprimo Marketing Operations. If this tenant renamed the Project object (e.g. 'Workstream', 'Effort', 'Track'), this is still the right tool. Use for Projects — not Activities/campaigns (use get_activity for those). Returns only the base Project record itself — not any Project sub-resource (DAM collection link, role members/memberships, tasks, attachments, chat access, etc.), each of which has its own get_project_* tool. Resolves status, project manager, and the linked Activity to human-readable labels/names and includes clickable deep links.
Response format: the markdown block is pre-rendered with the tenant's own terminology, locale-formatted dates, and resolved labels, and is intended to be displayed verbatim, including every (id: N) suffix and the deep-link heading.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
title | string (optional) | |
projectStatusId | integer (optional) | |
projectStatusLabel | string (optional) | |
description | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
projectManagerId | integer (optional) | |
projectManagerName | string (optional) | |
activityId | integer | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
deepLink | string (optional) | |
workflowId | integer (optional) | PM's workflow id for this project. Nullable per the schema. |
projectTypeId | integer (optional) | PM's project-type id. Nullable per the schema. |
modifiedDate | string (optional) | The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ). |
modifiedUserId | integer (optional) | The user id who last modified the project. |
timeZoneId | integer (optional) | PM's time-zone id for the project's dates. |
projectScalingTypeId | integer (optional) | PM's project-scaling-type id. |
associatedProjectId | integer (optional) | The id of another project this one is associated with, if any. |
changeOrder | boolean (optional) | Whether this project represents a change order. |
projectedEndDate | string (optional) | Projected end date (distinct from the committed ). |
baselineEndDate | string (optional) | Baseline end date snapshot. |
brandName | string (optional) | The brand name associated with the project, when set. |
get_project_dam_collection
Not currently available
Returns the DAM collections linked to a Project, by the project's integer ID, in Aprimo Marketing Operations. Each entry carries the DAM collection's GUID id and name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
count | integer | |
items | array of ProjectDamCollectionItem | |
items[].projectId | integer | |
items[].collectionId | string (optional) | The DAM collection's GUID id. |
items[].collectionName | string (optional) |
get_project_role_members
Returns the members of a project role, by project ID and project-role ID, in Aprimo Marketing Operations. Optionally includes each member's first/last name inline.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID. |
projectRoleId | string | Yes | The project role's integer ID. |
includeUserName | boolean | No | When true, include each member's first/last name inline. Default false. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
projectRoleId | integer | |
count | integer | |
items | array of ProjectRoleMemberItemProjection | |
items[].projectRoleMemberId | integer (optional) | |
items[].projectRoleId | integer | |
items[].userId | integer (optional) | |
items[].firstName | string (optional) | |
items[].lastName | string (optional) | |
items[].projectRole | ProjectRoleInfoProjection (optional) | |
items[].projectRole.projectRoleId | integer | |
items[].projectRole.projectId | integer | |
items[].projectRole.userRoleId | integer |
get_project_role_memberships
Returns all role memberships for a project, by the project's integer ID, in Aprimo Marketing Operations. Resolves each role member's user name.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
activityId | integer (optional) | |
projectId | integer | |
projectName | string (optional) | |
roles | array of ProjectRoleUserItemProjection | |
roles[].roleId | integer (optional) | |
roles[].userId | integer (optional) | |
roles[].userName | string (optional) | |
roles[].userTokenId | integer (optional) | |
roles[].userToken | string (optional) | |
roles[].projectRoleId | integer (optional) |
get_projects_for_activity
Lists the Projects that belong to an Activity (marketing campaign), by the activity's integer ID, in Aprimo Marketing Operations. Returns totals and human-readable labels for status, project manager, and the linked Activity.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes and deep-link headings.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The parent activity'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', 'Title'). 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 ProjectProjection | The items returned in this response. |
items[].projectId | integer | |
items[].title | string (optional) | |
items[].projectStatusId | integer (optional) | |
items[].projectStatusLabel | string (optional) | |
items[].description | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].projectManagerId | integer (optional) | |
items[].projectManagerName | string (optional) | |
items[].activityId | integer | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].deepLink | string (optional) | |
items[].workflowId | integer (optional) | PM's workflow id for this project. Nullable per the schema. |
items[].projectTypeId | integer (optional) | PM's project-type id. Nullable per the schema. |
items[].modifiedDate | string (optional) | The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ). |
items[].modifiedUserId | integer (optional) | The user id who last modified the project. |
items[].timeZoneId | integer (optional) | PM's time-zone id for the project's dates. |
items[].projectScalingTypeId | integer (optional) | PM's project-scaling-type id. |
items[].associatedProjectId | integer (optional) | The id of another project this one is associated with, if any. |
items[].changeOrder | boolean (optional) | Whether this project represents a change order. |
items[].projectedEndDate | string (optional) | Projected end date (distinct from the committed ). |
items[].baselineEndDate | string (optional) | Baseline end date snapshot. |
items[].brandName | string (optional) | The brand name associated with the project, when set. |
list_projects
Lists Projects in Aprimo Marketing Operations, paged. Optionally narrow by title substring and/or status. Use search_projects when you need richer filtering (project manager, linked activity, extended attributes, the query DSL); use this to browse. Returns totals and human-readable labels for status, project manager, and the linked Activity.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim, including (id: N) suffixes and deep-link headings.
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', 'Title'). Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
titleFilter | string | No | Optional case-insensitive title substring filter. |
projectStatusLabel | string | No | Optional status filter (label, case-insensitive, e.g. 'Active', 'Closed'). Resolved against the PM ProjectStatus lookup list; returns an error if the label doesn't match any known status. |
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 ProjectProjection | The items returned in this response. |
items[].projectId | integer | |
items[].title | string (optional) | |
items[].projectStatusId | integer (optional) | |
items[].projectStatusLabel | string (optional) | |
items[].description | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].projectManagerId | integer (optional) | |
items[].projectManagerName | string (optional) | |
items[].activityId | integer | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].deepLink | string (optional) | |
items[].workflowId | integer (optional) | PM's workflow id for this project. Nullable per the schema. |
items[].projectTypeId | integer (optional) | PM's project-type id. Nullable per the schema. |
items[].modifiedDate | string (optional) | The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ). |
items[].modifiedUserId | integer (optional) | The user id who last modified the project. |
items[].timeZoneId | integer (optional) | PM's time-zone id for the project's dates. |
items[].projectScalingTypeId | integer (optional) | PM's project-scaling-type id. |
items[].associatedProjectId | integer (optional) | The id of another project this one is associated with, if any. |
items[].changeOrder | boolean (optional) | Whether this project represents a change order. |
items[].projectedEndDate | string (optional) | Projected end date (distinct from the committed ). |
items[].baselineEndDate | string (optional) | Baseline end date snapshot. |
items[].brandName | string (optional) | The brand name associated with the project, when set. |
list_projects_display
Returns a paged, sortable display list of Projects for list/grid presentation in Aprimo Marketing Operations, optionally filtered by project statuses, title, and activity ID.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
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. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
titleFilter | string | No | Optional case-insensitive title substring filter. |
projectStatusLabel | string | No | Optional status filter (label, case-insensitive, e.g. 'Active', 'Closed'). Resolved against the PM ProjectStatus lookup list; returns an error if the label doesn't match any known status. |
activityId | string | No | Optional linked activity's integer ID to narrow the display list to. |
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 ProjectSummaryProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].title | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
list_projects_for_attachment
Lists the Projects that an attachment (by integer ID) is associated with, in Aprimo Marketing Operations, paged and sortable.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
attachmentId | string | Yes | The attachment's integer ID. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
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 ProjectSummaryProjection | The items returned in this response. |
items[].id | string (optional) | |
items[].title | string (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
search_projects
Searches Projects in Aprimo Marketing Operations. If this tenant has renamed the Project object (e.g. to 'Workstream', 'Effort', 'Track'), users will mention it by this tenant's term — use this tool whenever the user means Projects, regardless of the word they say. Returns a paged list with totals and human-readable labels for status, Project manager name, and the linked Activity's name. Each Project carries the linked Activity's id, name, and deep link. Use this tool for Projects — not for Activities/campaigns (use search_activities for those).
Response format. Each item comes back as a markdown block pre-rendered server-side using the tenant's own terminology: labels reflect tenant configuration, dates are locale-formatted, lookup values are resolved to display strings, and the heading is a clickable deep link. The block is intended to be displayed verbatim rather than re-rendered from the structured payload. If you do re-render it, preserve the tenant-localized labels, the (id: N) suffixes (which enable follow-up filters), the date formatting, and the deep-link heading.
Filtering. Prefer the name-keyed filter parameters (projectStatusLabel, projectManagerName) over composing the query DSL. For extended attributes — tenant-configured custom fields beyond the standard set — use attributeFilters to match a specific value, and attributesPresent to match any value or no value. Extended attributes cannot be addressed through query; pass the display name as written.
Query DSL. query takes a structured operator tree using PascalCase FieldName/FieldValue. By partial title: query='{"contains":{"FieldName":"Title","FieldValue":"hero"}}'. By id: query='{"equals":{"FieldName":"ProjectId","FieldValue":67890}}'. To browse without a filter use list_projects 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. 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 PM's wire field name ('ProjectId', 'Title', 'ActivityId', 'ProjectManager', 'ProjectStatus', 'EndDate', etc.) and FieldValue is a native JSON value matching the field's type (integer for IDs, ISO 8601 string for dates, string for text). 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_projects to browse without a filter. For status/project-manager filtering, prefer the name-keyed parameters below. Examples: by id '{"equals":{"FieldName":"ProjectId","FieldValue":67890}}'; by title (partial) '{"contains":{"FieldName":"Title","FieldValue":"hero"}}'; by end date '{"lessthan":{"FieldName":"EndDate","FieldValue":"2026-07-01"}}'; by linked activity '{"equals":{"FieldName":"ActivityId","FieldValue":13801}}'. |
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', 'Title'). Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
projectStatusLabel | string | No | Filter to projects with this status (label, case-insensitive, e.g. 'Active', 'Closed'). Resolved against the PM ProjectStatus lookup list. Returns an error if the label doesn't match any known status. Combined with query and other filters via and. |
projectManagerName | string | No | Filter to projects whose project manager's first or last name matches this string (case-insensitive substring). Examples: 'Alice', 'Adams', 'alice ad'. If multiple users match, all are included (or). If no users match, returns an empty result set with a message — not an error. |
attributeFilters | object (map of string) | No | Filter by extended attributes with a specific value. Tenant-configured custom fields beyond the standard set. Pass a dictionary keyed by the attribute's display name exactly as the user/admin sees it, with the desired value as a string. For lookup-type EAs (picklists), pass the option's display label — the server translates to the underlying itemId. For text/number/date EAs, pass the value as a string — the server passes it through. Returns BadRequest with the valid attribute set if a key doesn't match any EA. Combined with query and other filters via and. |
attributesPresent | object (map of boolean) | No | Filter by extended attribute presence — for natural-language patterns like 'projects with any value for Region' or 'projects missing a Phase Gate tag'. Pass a dictionary keyed by the attribute's display name, with a boolean value: True = the EA has any value (isnotnull); False = the EA has no value (isnull). Use this when the user does not specify a particular value to match. |
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 ProjectProjection | The items returned in this response. |
items[].projectId | integer | |
items[].title | string (optional) | |
items[].projectStatusId | integer (optional) | |
items[].projectStatusLabel | string (optional) | |
items[].description | string (optional) | |
items[].beginDate | string (optional) | |
items[].endDate | string (optional) | |
items[].projectManagerId | integer (optional) | |
items[].projectManagerName | string (optional) | |
items[].activityId | integer | |
items[].activityName | string (optional) | |
items[].activityDeepLink | string (optional) | |
items[].deepLink | string (optional) | |
items[].workflowId | integer (optional) | PM's workflow id for this project. Nullable per the schema. |
items[].projectTypeId | integer (optional) | PM's project-type id. Nullable per the schema. |
items[].modifiedDate | string (optional) | The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ). |
items[].modifiedUserId | integer (optional) | The user id who last modified the project. |
items[].timeZoneId | integer (optional) | PM's time-zone id for the project's dates. |
items[].projectScalingTypeId | integer (optional) | PM's project-scaling-type id. |
items[].associatedProjectId | integer (optional) | The id of another project this one is associated with, if any. |
items[].changeOrder | boolean (optional) | Whether this project represents a change order. |
items[].projectedEndDate | string (optional) | Projected end date (distinct from the committed ). |
items[].baselineEndDate | string (optional) | Baseline end date snapshot. |
items[].brandName | string (optional) | The brand name associated with the project, when set. |
Manage a Project
Can change data · 8 tools · Group ID manage-a-project
Needs: View Projects, View Activities, Look Up PM Reference Data, Look Up PM Users, Groups & Roles
| Tool | What it does |
|---|---|
cancel_project | Destructive. Cancels a Project in Aprimo Marketing Operations. |
close_project | Destructive. Closes a Project in Aprimo Marketing Operations. |
create_project | Creates a new Project in Aprimo Marketing Operations. |
pause_project | Destructive. Pauses a Project in Aprimo Marketing Operations. |
save_project_roles | Adds a role to a project, by the project's integer ID, in Aprimo Marketing Operations. |
start_project | Destructive. Transitions a Project to started in Aprimo Marketing Operations. |
update_project | Updates an existing Project by its integer ID in Aprimo Marketing Operations. |
update_project_role_memberships | Replaces the role memberships for a project, by the project's integer ID, in Aprimo Marketing Operations. |
cancel_project
Destructive
Cancels a Project in Aprimo Marketing Operations. This is a state change that terminates the project's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact Project with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID to cancel. |
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) — cancelling a project changes its state. Set only after stating the exact project to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
action | string (optional) | The state-change action performed: "start", "cancel", "pause", or "close". |
succeeded | boolean | |
deepLink | string (optional) | UI deep link to the affected project. |
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.
close_project
Destructive
Closes a Project in Aprimo Marketing Operations. This is a state change that completes the project's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact Project with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project'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 project changes its state. Set only after stating the exact project to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
action | string (optional) | The state-change action performed: "start", "cancel", "pause", or "close". |
succeeded | boolean | |
deepLink | string (optional) | UI deep link to the affected project. |
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.
create_project
Creates a new Project in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload (title, dates, linked activity, project manager, etc.). Returns the created Project with resolved labels and deep links.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new project's fields (PM wire names, e.g. {"title":"Hero Image Production","activityId":13801,"projectManager":1042}). Pass PM's wire field names; the server sends the object as-is. |
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 exact payload. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
title | string (optional) | |
projectStatusId | integer (optional) | |
projectStatusLabel | string (optional) | |
description | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
projectManagerId | integer (optional) | |
projectManagerName | string (optional) | |
activityId | integer | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
deepLink | string (optional) | |
workflowId | integer (optional) | PM's workflow id for this project. Nullable per the schema. |
projectTypeId | integer (optional) | PM's project-type id. Nullable per the schema. |
modifiedDate | string (optional) | The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ). |
modifiedUserId | integer (optional) | The user id who last modified the project. |
timeZoneId | integer (optional) | PM's time-zone id for the project's dates. |
projectScalingTypeId | integer (optional) | PM's project-scaling-type id. |
associatedProjectId | integer (optional) | The id of another project this one is associated with, if any. |
changeOrder | boolean (optional) | Whether this project represents a change order. |
projectedEndDate | string (optional) | Projected end date (distinct from the committed ). |
baselineEndDate | string (optional) | Baseline end date snapshot. |
brandName | string (optional) | The brand name associated with the project, when set. |
pause_project
Destructive
Pauses a Project in Aprimo Marketing Operations. This is a state change that halts the project's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact Project with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID to pause. |
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) — pausing a project changes its state. Set only after stating the exact project to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
action | string (optional) | The state-change action performed: "start", "cancel", "pause", or "close". |
succeeded | boolean | |
deepLink | string (optional) | UI deep link to the affected project. |
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.
save_project_roles
Adds a role to a project, by the project's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the save result (new project role id, or validation errors).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID. |
body | string | Yes | JSON object with the role to add (PM wire names, e.g. userRoleId). projectId is populated automatically from the projectId parameter above -- do not include it. |
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 |
|---|---|---|
result | integer (optional) | |
isValid | boolean | |
validationErrors | array of string (optional) | |
validationMessages | array of ValidationMessageProjection (optional) | |
validationMessages[].formatResourceId | string (optional) | |
validationMessages[].argumentResourceIds | array of string (optional) | |
validationMessages[].formattedMessage | string (optional) |
start_project
Destructive
Transitions a Project to started in Aprimo Marketing Operations. This is a state change that kicks off the project's workflow. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact Project with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID to start. |
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) — this changes the project's state. Set only after stating the exact project to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
action | string (optional) | The state-change action performed: "start", "cancel", "pause", or "close". |
succeeded | boolean | |
deepLink | string (optional) | UI deep link to the affected project. |
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_project
Updates an existing Project by its integer 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 Project.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project'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 |
|---|---|---|
projectId | integer | |
title | string (optional) | |
projectStatusId | integer (optional) | |
projectStatusLabel | string (optional) | |
description | string (optional) | |
beginDate | string (optional) | |
endDate | string (optional) | |
projectManagerId | integer (optional) | |
projectManagerName | string (optional) | |
activityId | integer | |
activityName | string (optional) | |
activityDeepLink | string (optional) | |
deepLink | string (optional) | |
workflowId | integer (optional) | PM's workflow id for this project. Nullable per the schema. |
projectTypeId | integer (optional) | PM's project-type id. Nullable per the schema. |
modifiedDate | string (optional) | The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ). |
modifiedUserId | integer (optional) | The user id who last modified the project. |
timeZoneId | integer (optional) | PM's time-zone id for the project's dates. |
projectScalingTypeId | integer (optional) | PM's project-scaling-type id. |
associatedProjectId | integer (optional) | The id of another project this one is associated with, if any. |
changeOrder | boolean (optional) | Whether this project represents a change order. |
projectedEndDate | string (optional) | Projected end date (distinct from the committed ). |
baselineEndDate | string (optional) | Baseline end date snapshot. |
brandName | string (optional) | The brand name associated with the project, when set. |
update_project_role_memberships
Replaces the role memberships for a project, by the project's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact new memberships. Returns the updated memberships.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID. |
body | string | Yes | JSON object with the new role memberships (PM wire names, e.g. { "roles": [{ "roleId": 1, "userId": 42 }] }). |
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 |
|---|---|---|
activityId | integer (optional) | |
projectId | integer | |
projectName | string (optional) | |
roles | array of ProjectRoleUserItemProjection | |
roles[].roleId | integer (optional) | |
roles[].userId | integer (optional) | |
roles[].userName | string (optional) | |
roles[].userTokenId | integer (optional) | |
roles[].userToken | string (optional) | |
roles[].projectRoleId | integer (optional) |
View Work Requests
Read-only · 9 tools · Group ID view-work-requests
Needs: Look Up PM Reference Data, Look Up PM Users, Groups & Roles
| Tool | What it does |
|---|---|
get_work_request | Returns a single work request by its integer ID in Aprimo Marketing Operations, including its hypermedia action links. |
get_work_request_form | Returns a single work request form by its activity id in Aprimo Marketing Operations. |
list_work_request_categories | Lists work request categories in Aprimo Marketing Operations. |
list_work_request_forms | Returns a paginated list of work request forms, without field data, in Aprimo Marketing Operations. |
list_work_request_forms_by_category | Returns a paginated list of work request forms in the given category (siteId), without field data, in Aprimo Marketing Operations. |
list_work_request_reviews | Lists the requesting user's assigned work request reviews in Aprimo Marketing Operations, paged. |
list_work_requests | Lists the requesting user's work requests in Aprimo Marketing Operations, paged. |
search_work_request_forms | Searches work request forms in Aprimo Marketing Operations using a JSON query body, returns a paginated, sortable result set. |
search_work_requests | Searches work requests in Aprimo Marketing Operations with a JSON query body, returns a paged list. |
get_work_request
Returns a single work request by its integer ID in Aprimo Marketing Operations, including its hypermedia action links. Not its form (use get_work_request_form for that).
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The work request'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_work_request_form
Returns a single work request form by its activity 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 |
|---|---|---|---|
activityId | string | Yes | The work request form's activity 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. |
list_work_request_categories
Lists work request categories in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters: none.
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 WorkRequestCategoryProjection | 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_work_request_forms
Returns a paginated list of work request forms, without field data, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
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). |
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 WorkRequestFormProjection | 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. |
list_work_request_forms_by_category
Returns a paginated list of work request forms in the given category (siteId), without field data, in Aprimo Marketing Operations.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
siteId | string | Yes | The work request category's integer ID (siteId). |
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). |
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 WorkRequestFormProjection | 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. |
list_work_request_reviews
Lists the requesting user's assigned work request reviews in Aprimo Marketing Operations, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
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). |
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 WorkRequestProjection | 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. |
list_work_requests
Lists the requesting user's work requests in Aprimo Marketing Operations, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
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). |
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 WorkRequestProjection | 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_work_request_forms
Searches work request forms in Aprimo Marketing Operations using a JSON query body, returns a paginated, sortable result set. 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 object with the search query PM expects (PM query DSL). 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 WorkRequestFormProjection | 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_work_requests
Searches work requests in Aprimo Marketing Operations with a JSON query body, returns a paged list. 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 object with the search query PM expects (PM query DSL). 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 WorkRequestProjection | 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. |