Skip to main content

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.

How to read this page
  • Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
  • Needs. Enabling a group also enables every group it needs. Each group below lists them.
  • Read-only groups are intended for look-up access without the ability to change data.
  • Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. See the MCP Tool Permission Map.
  • Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both confirmed and confirmedDestructive to true.
  • Not currently available tools are registered but are not offered in any tool list at this time.
  • Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.

Groups in this area​

GroupAccessNeedsTools
View ActivitiesRead-onlyLook Up PM Reference Data8
Edit ActivitiesCan change dataView Activities, Look Up PM Reference Data, Look Up PM Users, Groups & Roles9
View ProgramsRead-onlyView Activities3
Edit ProgramsCan change dataView Programs1
View ProposalsRead-onlyView Activities, View Programs5
Edit ProposalsCan change dataView Proposals, View Activities, Look Up PM Reference Data2
Content PlanningCan change dataView Activities, Look Up PM Users, Groups & Roles13
Calendar ManagementCan change dataView Activities, Look Up PM Users, Groups & Roles4
View ProjectsRead-onlyView Activities9
Manage a ProjectCan change dataView Projects, View Activities, Look Up PM Reference Data, Look Up PM Users, Groups & Roles8
View Work RequestsRead-onlyLook Up PM Reference Data, Look Up PM Users, Groups & Roles9

View Activities​

Read-only · 8 tools · Group ID view-activities

Needs: Look Up PM Reference Data

ToolWhat it does
get_activityReturns a single Activity (marketing campaign) by its integer ID from Aprimo Marketing Operations.
get_activity_for_attachmentReturns the Activities (marketing campaign) an attachment belongs to, by the attachment's integer ID, in Aprimo Marketing Operations.
get_activity_roleReturns a single activity role, including its resolved member users and user tokens, in Aprimo Marketing Operations.
get_associated_activitiesReturns the Activities (marketing campaigns) associated with a DAM record, by the record's ID, in Aprimo Marketing Operations.
list_activitiesLists Activities (marketing campaigns) in Aprimo Marketing Operations, paged and unfiltered.
list_activity_rolesLists the roles assigned to an activity, by the activity's integer ID, in Aprimo Marketing Operations.
list_recent_activitiesLists Activities (marketing campaigns) recently accessed by the current user, in Aprimo Marketing Operations.
search_activitiesSearches 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:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.

Returns:

FieldTypeDescription
activityIdinteger
titlestring (optional)
descriptionstring (optional)
activityTypeIdinteger (optional)
activityTypeLabelstring (optional)
activityStateIdinteger (optional)
activityStateLabelstring (optional)
timeZoneIdinteger (optional)
timeZoneLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
projectAnchorDatestring (optional)
ownerIdinteger (optional)
ownerNamestring (optional)
administratorIdinteger (optional)
administratorNamestring (optional)
creatorIdinteger (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.
modifiedDatestring (optional)The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ).
proposalIdinteger (optional)The activity proposal this activity was created from, if any.
deepLinkstring (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:

ParameterTypeRequiredDescription
attachmentIdstringYesThe attachment's integer ID.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
rawobject (optional)

get_activity_role​

Returns a single activity role, including its resolved member users and user tokens, in Aprimo Marketing Operations.

Parameters:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.
roleIdstringYesThe role's integer ID.

Returns:

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

ParameterTypeRequiredDescription
adamRecordIdstringYesThe DAM record ID the activities are associated with.

Returns:

FieldTypeDescription
adamRecordIdstring (optional)
countinteger
itemsarray of ActivityProjection
items[].activityIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].activityTypeIdinteger (optional)
items[].activityTypeLabelstring (optional)
items[].activityStateIdinteger (optional)
items[].activityStateLabelstring (optional)
items[].timeZoneIdinteger (optional)
items[].timeZoneLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].projectAnchorDatestring (optional)
items[].ownerIdinteger (optional)
items[].ownerNamestring (optional)
items[].administratorIdinteger (optional)
items[].administratorNamestring (optional)
items[].creatorIdinteger (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[].modifiedDatestring (optional)The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ).
items[].proposalIdinteger (optional)The activity proposal this activity was created from, if any.
items[].deepLinkstring (optional)
rawobject (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:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ActivityProjectionThe items returned in this response.
items[].activityIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].activityTypeIdinteger (optional)
items[].activityTypeLabelstring (optional)
items[].activityStateIdinteger (optional)
items[].activityStateLabelstring (optional)
items[].timeZoneIdinteger (optional)
items[].timeZoneLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].projectAnchorDatestring (optional)
items[].ownerIdinteger (optional)
items[].ownerNamestring (optional)
items[].administratorIdinteger (optional)
items[].administratorNamestring (optional)
items[].creatorIdinteger (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[].modifiedDatestring (optional)The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ).
items[].proposalIdinteger (optional)The activity proposal this activity was created from, if any.
items[].deepLinkstring (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:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.

Returns:

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

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

ParameterTypeRequiredDescription
querystringYesJSON-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"}}]}'.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by (e.g. 'ModifiedDate', 'Name'). Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.
activityTypeLabelstringNoFilter 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.
activityStateLabelstringNoFilter 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.
ownerNamestringNoFilter 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.
administratorNamestringNoFilter to activities whose administrator's first or last name matches this string (case-insensitive substring). Same matching semantics as ownerName.
attributeFiltersobject (map of string)NoFilter 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.
attributesPresentobject (map of boolean)NoFilter 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:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ActivityProjectionThe items returned in this response.
items[].activityIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].activityTypeIdinteger (optional)
items[].activityTypeLabelstring (optional)
items[].activityStateIdinteger (optional)
items[].activityStateLabelstring (optional)
items[].timeZoneIdinteger (optional)
items[].timeZoneLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].projectAnchorDatestring (optional)
items[].ownerIdinteger (optional)
items[].ownerNamestring (optional)
items[].administratorIdinteger (optional)
items[].administratorNamestring (optional)
items[].creatorIdinteger (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[].modifiedDatestring (optional)The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ).
items[].proposalIdinteger (optional)The activity proposal this activity was created from, if any.
items[].deepLinkstring (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

ToolWhat it does
add_activity_role_membersAdds one or more user or user-token members to an activity role, merging with existing members and skipping duplicates, in Aprimo Marketing Operations.
create_activityCreates a new Activity (marketing campaign) in Aprimo Marketing Operations.
create_activity_milestoneNot currently available. Creates a milestone under an Activity (marketing campaign), by the parent activity's integer ID, in Aprimo Marketing Operations.
create_activity_roleCreates a role on an activity from the supplied user role and members, in Aprimo Marketing Operations.
delete_activityDestructive. Permanently deletes an Activity (marketing campaign) by its integer ID in Aprimo Marketing Operations.
delete_activity_roleDestructive. Permanently deletes a role from an activity in Aprimo Marketing Operations.
remove_activity_role_memberDestructive. Permanently removes a single member from an activity role in Aprimo Marketing Operations.
update_activityUpdates an existing Activity (marketing campaign) by its integer ID in Aprimo Marketing Operations.
update_activity_roleReplaces 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:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.
roleIdstringYesThe role's integer ID.
bodystringYesJSON object with the members to add (PM wire names).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload.

Returns:

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

ParameterTypeRequiredDescription
bodystringYesJSON 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.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the exact payload.

Returns:

FieldTypeDescription
activityIdinteger
titlestring (optional)
descriptionstring (optional)
activityTypeIdinteger (optional)
activityTypeLabelstring (optional)
activityStateIdinteger (optional)
activityStateLabelstring (optional)
timeZoneIdinteger (optional)
timeZoneLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
projectAnchorDatestring (optional)
ownerIdinteger (optional)
ownerNamestring (optional)
administratorIdinteger (optional)
administratorNamestring (optional)
creatorIdinteger (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.
modifiedDatestring (optional)The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ).
proposalIdinteger (optional)The activity proposal this activity was created from, if any.
deepLinkstring (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:

ParameterTypeRequiredDescription
activityIdstringYesThe parent activity's integer ID.
bodystringYesJSON object with the milestone's fields (PM wire names).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload.

Returns:

FieldTypeDescription
activityDateIdinteger
activityIdinteger
titlestring (optional)
descriptionstring (optional)
startDatestring (optional)
endDatestring (optional)
scheduleTypeinteger (optional)
timeZoneinteger (optional)
milestoneEaIdinteger (optional)
rawobject (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:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.
bodystringYesJSON object with the new role's data (PM wire names), including the user role and its members.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload.

Returns:

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

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact activity.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
activityIdinteger
deletedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


delete_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:

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

Returns:

FieldTypeDescription
activityIdinteger
roleIdinteger
deletedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.
roleIdstringYesThe role's integer ID.
memberIdstringYesThe member's integer ID to remove.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
activityIdinteger
roleIdinteger
memberIdinteger
removedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
activityIdinteger
titlestring (optional)
descriptionstring (optional)
activityTypeIdinteger (optional)
activityTypeLabelstring (optional)
activityStateIdinteger (optional)
activityStateLabelstring (optional)
timeZoneIdinteger (optional)
timeZoneLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
projectAnchorDatestring (optional)
ownerIdinteger (optional)
ownerNamestring (optional)
administratorIdinteger (optional)
administratorNamestring (optional)
creatorIdinteger (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.
modifiedDatestring (optional)The activity's last-modified timestamp, PM's raw ISO-8601 string reformatted for the tenant's locale (same treatment as ).
proposalIdinteger (optional)The activity proposal this activity was created from, if any.
deepLinkstring (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:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.
roleIdstringYesThe role's integer ID to update.
bodystringYesJSON object with the full replacement role data (PM wire names), including the user role and its members.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

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

ToolWhat it does
get_programReturns a single program by its integer ID in Aprimo Marketing Operations.
get_programs_for_activityReturns the programs associated with an activity, by the activity's integer ID, in Aprimo Marketing Operations, paged.
list_programsLists 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:

ParameterTypeRequiredDescription
programIdstringNoThe program's integer ID. Provide either programId or name, not both.
namestringNoThe program's name. Provide either programId or name, not both.

Returns:

FieldTypeDescription
programIdinteger
titlestring (optional)PM's real wire field for this is title, not name -- see the class remarks.
ownerIdinteger (optional)
descriptionstring (optional)
startDatestring (optional)
endDatestring (optional)
programTypeIdinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
clientIdinteger (optional)
brandIdinteger (optional)
classificationIdinteger (optional)
rawobject (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:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ProgramProjectionThe items returned in this response.
items[].programIdinteger
items[].titlestring (optional)PM's real wire field for this is title, not name -- see the class remarks.
items[].ownerIdinteger (optional)
items[].descriptionstring (optional)
items[].startDatestring (optional)
items[].endDatestring (optional)
items[].programTypeIdinteger (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (optional)
items[].clientIdinteger (optional)
items[].brandIdinteger (optional)
items[].classificationIdinteger (optional)
items[].rawobject (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:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ProgramProjectionThe items returned in this response.
items[].programIdinteger
items[].titlestring (optional)PM's real wire field for this is title, not name -- see the class remarks.
items[].ownerIdinteger (optional)
items[].descriptionstring (optional)
items[].startDatestring (optional)
items[].endDatestring (optional)
items[].programTypeIdinteger (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (optional)
items[].clientIdinteger (optional)
items[].brandIdinteger (optional)
items[].classificationIdinteger (optional)
items[].rawobject (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

ToolWhat it does
update_programUpdates 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:

ParameterTypeRequiredDescription
programIdstringNoThe program's integer ID. Provide either programId or name, not both.
namestringNoThe program's name. Provide either programId or name, not both.
bodystringNoJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
programIdinteger
titlestring (optional)PM's real wire field for this is title, not name -- see the class remarks.
ownerIdinteger (optional)
descriptionstring (optional)
startDatestring (optional)
endDatestring (optional)
programTypeIdinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
clientIdinteger (optional)
brandIdinteger (optional)
classificationIdinteger (optional)
rawobject (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

ToolWhat it does
get_activity_proposalReturns a single activity proposal by its integer ID in Aprimo Marketing Operations.
get_program_proposalNot currently available. Returns a single program proposal by its integer ID in Aprimo Marketing Operations.
list_activity_proposal_templatesLists activity proposal templates in Aprimo Marketing Operations, paged.
search_activity_proposalsSearches activity proposals in Aprimo Marketing Operations by title, paged.
search_program_proposalsSearches 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:

ParameterTypeRequiredDescription
proposalIdstringYesThe activity proposal's integer ID.

Returns:

FieldTypeDescription
proposalIdinteger
titlestring (optional)
descriptionstring (optional)
proposalStateIdinteger (optional)PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label.
activityTypeIdinteger (optional)
activityTypeLabelstring (optional)
ownerIdinteger (optional)
ownerNamestring (optional)
administratorIdinteger (optional)
administratorNamestring (optional)
beginDatestring (optional)
endDatestring (optional)
anchorDatestring (optional)
timeZoneIdinteger (optional)
timeZoneLabelstring (optional)
classificationIdinteger (optional)Raw id, no existing lookup-list resolver for classifications.
currencyCodeinteger (optional)Raw id, no existing lookup-list resolver for currency codes.
isTemplateboolean (optional)
totalCostnumber (optional)
submitDatestring (optional)The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
modifiedDatestring (optional)The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
programIdinteger (optional)The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
rawobject (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:

ParameterTypeRequiredDescription
proposalIdstringYesThe program proposal's integer ID.

Returns:

FieldTypeDescription
proposalIdinteger
titlestring (optional)
descriptionstring (optional)
classificationIdinteger (optional)Raw id, no existing lookup-list resolver for classifications.
proposalStateinteger (optional)PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: proposalState.
programTypeIdinteger (optional)Raw id, no existing lookup-list resolver for program types.
ownerIdinteger (optional)
ownerNamestring (optional)Not part of the wire schema -- filled by PmProgramProposalMapper.ResolveAsync.
beginDatestring (optional)
endDatestring (optional)
modifiedDatestring (optional)
modifiedUserinteger (optional)Wire field: modifiedUser.
modifiedByNamestring (optional)Not part of the wire schema -- filled by PmProgramProposalMapper.ResolveAsync.
currencyCodeinteger (optional)Raw id, no existing lookup-list resolver for currency codes.
submitDatestring (optional)
invoiceTotalnumber (optional)
materialTotalnumber (optional)
laborTotalnumber (optional)
tAndETotalnumber (optional)
totalCostnumber (optional)
approvalTypeinteger (optional)PM's ApprovalType enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: approvalType.
objectivestring (optional)
proposalTypeinteger (optional)PM's ProposalType enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: proposalType.
rawobject (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:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ActivityProposalProjectionThe items returned in this response.
items[].proposalIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].proposalStateIdinteger (optional)PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label.
items[].activityTypeIdinteger (optional)
items[].activityTypeLabelstring (optional)
items[].ownerIdinteger (optional)
items[].ownerNamestring (optional)
items[].administratorIdinteger (optional)
items[].administratorNamestring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].anchorDatestring (optional)
items[].timeZoneIdinteger (optional)
items[].timeZoneLabelstring (optional)
items[].classificationIdinteger (optional)Raw id, no existing lookup-list resolver for classifications.
items[].currencyCodeinteger (optional)Raw id, no existing lookup-list resolver for currency codes.
items[].isTemplateboolean (optional)
items[].totalCostnumber (optional)
items[].submitDatestring (optional)The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
items[].modifiedDatestring (optional)The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
items[].programIdinteger (optional)The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
items[].rawobject (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:

ParameterTypeRequiredDescription
titleFilterstringNoRequired case-insensitive substring filter on the proposal's title -- PM has no match-all query for this endpoint, so this cannot be omitted.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ActivityProposalProjectionThe items returned in this response.
items[].proposalIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].proposalStateIdinteger (optional)PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label.
items[].activityTypeIdinteger (optional)
items[].activityTypeLabelstring (optional)
items[].ownerIdinteger (optional)
items[].ownerNamestring (optional)
items[].administratorIdinteger (optional)
items[].administratorNamestring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].anchorDatestring (optional)
items[].timeZoneIdinteger (optional)
items[].timeZoneLabelstring (optional)
items[].classificationIdinteger (optional)Raw id, no existing lookup-list resolver for classifications.
items[].currencyCodeinteger (optional)Raw id, no existing lookup-list resolver for currency codes.
items[].isTemplateboolean (optional)
items[].totalCostnumber (optional)
items[].submitDatestring (optional)The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
items[].modifiedDatestring (optional)The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
items[].programIdinteger (optional)The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
items[].rawobject (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:

ParameterTypeRequiredDescription
titleFilterstringYesRequired case-insensitive substring filter on the proposal's title -- PM has no match-all query for this endpoint, so this cannot be omitted.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ProgramProposalProjectionThe items returned in this response.
items[].proposalIdinteger
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].classificationIdinteger (optional)Raw id, no existing lookup-list resolver for classifications.
items[].proposalStateinteger (optional)PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: proposalState.
items[].programTypeIdinteger (optional)Raw id, no existing lookup-list resolver for program types.
items[].ownerIdinteger (optional)
items[].ownerNamestring (optional)Not part of the wire schema -- filled by PmProgramProposalMapper.ResolveAsync.
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].modifiedDatestring (optional)
items[].modifiedUserinteger (optional)Wire field: modifiedUser.
items[].modifiedByNamestring (optional)Not part of the wire schema -- filled by PmProgramProposalMapper.ResolveAsync.
items[].currencyCodeinteger (optional)Raw id, no existing lookup-list resolver for currency codes.
items[].submitDatestring (optional)
items[].invoiceTotalnumber (optional)
items[].materialTotalnumber (optional)
items[].laborTotalnumber (optional)
items[].tAndETotalnumber (optional)
items[].totalCostnumber (optional)
items[].approvalTypeinteger (optional)PM's ApprovalType enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: approvalType.
items[].objectivestring (optional)
items[].proposalTypeinteger (optional)PM's ProposalType enum, as a raw integer -- no existing resolver maps it to a display label. Wire field: proposalType.
items[].rawobject (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

ToolWhat it does
create_activity_proposalCreates a new activity proposal in Aprimo Marketing Operations.
update_activity_proposalUpdates 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:

ParameterTypeRequiredDescription
bodystringYesJSON object with the new activity proposal's data (PM wire names).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload.

Returns:

FieldTypeDescription
proposalIdinteger
titlestring (optional)
descriptionstring (optional)
proposalStateIdinteger (optional)PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label.
activityTypeIdinteger (optional)
activityTypeLabelstring (optional)
ownerIdinteger (optional)
ownerNamestring (optional)
administratorIdinteger (optional)
administratorNamestring (optional)
beginDatestring (optional)
endDatestring (optional)
anchorDatestring (optional)
timeZoneIdinteger (optional)
timeZoneLabelstring (optional)
classificationIdinteger (optional)Raw id, no existing lookup-list resolver for classifications.
currencyCodeinteger (optional)Raw id, no existing lookup-list resolver for currency codes.
isTemplateboolean (optional)
totalCostnumber (optional)
submitDatestring (optional)The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
modifiedDatestring (optional)The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
programIdinteger (optional)The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
rawobject (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:

ParameterTypeRequiredDescription
proposalIdstringYesThe activity proposal's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
proposalIdinteger
titlestring (optional)
descriptionstring (optional)
proposalStateIdinteger (optional)PM's ProposalState enum, as a raw integer -- no existing resolver maps it to a display label.
activityTypeIdinteger (optional)
activityTypeLabelstring (optional)
ownerIdinteger (optional)
ownerNamestring (optional)
administratorIdinteger (optional)
administratorNamestring (optional)
beginDatestring (optional)
endDatestring (optional)
anchorDatestring (optional)
timeZoneIdinteger (optional)
timeZoneLabelstring (optional)
classificationIdinteger (optional)Raw id, no existing lookup-list resolver for classifications.
currencyCodeinteger (optional)Raw id, no existing lookup-list resolver for currency codes.
isTemplateboolean (optional)
totalCostnumber (optional)
submitDatestring (optional)The proposal's submission timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
modifiedDatestring (optional)The proposal's last-modified timestamp. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
programIdinteger (optional)The program this proposal is associated with, if any. New field surfaced now that PM's snapshot documents the full ActivityProposal schema.
rawobject (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

ToolWhat it does
associate_content_plan_activitiesAssociates the specified activities with a content plan, by the plan's integer ID, in Aprimo Marketing Operations.
create_content_plan_collectionCreates and links a new DAM collection for a content plan, by the plan's integer ID, in Aprimo Marketing Operations.
delete_content_planDestructive. Permanently deletes a content plan by its integer ID in Aprimo Marketing Operations.
get_content_planReturns a single content plan by its integer ID in Aprimo Marketing Operations.
get_content_plan_activity_progressReturns the activity progress for a content plan, by its integer ID, in Aprimo Marketing Operations.
get_content_plan_manage_activitiesLists the activities available to manage/associate for a content plan, by its integer ID, in Aprimo Marketing Operations, paged.
list_content_plansLists content plans in Aprimo Marketing Operations, paged and unfiltered.
notify_content_plan_activity_ownersNotifies the owners of the specified activities on a content plan, by the plan's integer ID, in Aprimo Marketing Operations.
remove_content_plan_activityDestructive. Removes the association between a content plan and the specified activities, by the plan's integer ID, in Aprimo Marketing Operations.
share_content_planShares a content plan with the specified users/groups, by the plan's integer ID, in Aprimo Marketing Operations.
unlink_content_plan_collectionDestructive. 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_planUpdates an existing content plan by its integer ID in Aprimo Marketing Operations.
update_content_plan_collectionUpdates 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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.
activityIdsstringYesJSON array of the activities' integer IDs to associate, e.g. "[13801,13802]".
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the exact activity list.

Returns:

FieldTypeDescription
planIdinteger
actionstring (optional)"associate", "remove", or "notify-owners".
activityIdsarray 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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.
bodystringYesJSON object with the new DAM collection's data (PM wire names).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload.

Returns:

FieldTypeDescription
planIdinteger
collectionIdstring (optional)
collectionTypeinteger (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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID to delete.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact content plan.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
planIdinteger
deletedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


get_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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.

Returns:

FieldTypeDescription
planIdinteger
scsIdinteger (optional)PM's internal scs id for this content plan. New field surfaced now that PM's snapshot documents the full ContentPlan schema.
titlestring (optional)
descriptionstring (optional)
statusIdinteger (optional)[StaticLookupList] field resolved via PmFieldLabelCache (inlined on /metadata/ContentPlan), same mechanism as .
statusLabelstring (optional)
typeIdinteger (optional)[StaticLookupList] field, same resolution mechanism as .
typeLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
administratorIdinteger (optional)
administratorNamestring (optional)
modifiedUserIdinteger (optional)
modifiedUserNamestring (optional)
modifiedDatestring (optional)
backgroundThemestring (optional)
canReadboolean (optional)
canModifyboolean (optional)
canCreateActivityboolean (optional)
canModifyActivityboolean (optional)
collectionsarray of ContentPlanCollection (optional)DAM collections linked to this content plan. Null when the wire object carried none.
collections[].planIdinteger (optional)
collections[].collectionIdstring (optional)The linked DAM collection's GUID id.
collections[].collectionTypeinteger (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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.

Returns:

FieldTypeDescription
planIdinteger
countinteger
itemsarray of ContentPlanActivityProgressEntry
items[].activityIdinteger
items[].activityNamestring (optional)
items[].activityDeepLinkstring (optional)
items[].progressobject (optional)The per-activity progress payload, verbatim (shape not stabilized upstream).
rawobject (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:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ContentPlanManageActivityItemThe items returned in this response.
items[].scsIdinteger (optional)
items[].namestring (optional)
items[].beginDatestring (optional)No corresponding field in PM's manage-activities item schema -- always null (see the class remarks).
items[].endDatestring (optional)
items[].ownerIdinteger (optional)
items[].ownerNamestring (optional)
items[].administratorIdinteger (optional)
items[].administratorNamestring (optional)
items[].activityTypeIdinteger (optional)
items[].activityTypeLabelstring (optional)
items[].activityStateIdinteger (optional)No corresponding field in PM's manage-activities item schema -- always null (see the class remarks).
items[].activityStateLabelstring (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:

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

Returns:

FieldTypeDescription
countinteger
offsetinteger
itemsarray of ContentPlanProjection
items[].planIdinteger
items[].scsIdinteger (optional)PM's internal scs id for this content plan. New field surfaced now that PM's snapshot documents the full ContentPlan schema.
items[].titlestring (optional)
items[].descriptionstring (optional)
items[].statusIdinteger (optional)[StaticLookupList] field resolved via PmFieldLabelCache (inlined on /metadata/ContentPlan), same mechanism as .
items[].statusLabelstring (optional)
items[].typeIdinteger (optional)[StaticLookupList] field, same resolution mechanism as .
items[].typeLabelstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].administratorIdinteger (optional)
items[].administratorNamestring (optional)
items[].modifiedUserIdinteger (optional)
items[].modifiedUserNamestring (optional)
items[].modifiedDatestring (optional)
items[].backgroundThemestring (optional)
items[].canReadboolean (optional)
items[].canModifyboolean (optional)
items[].canCreateActivityboolean (optional)
items[].canModifyActivityboolean (optional)
items[].collectionsarray of ContentPlanCollection (optional)DAM collections linked to this content plan. Null when the wire object carried none.
items[].collections[].planIdinteger (optional)
items[].collections[].collectionIdstring (optional)The linked DAM collection's GUID id.
items[].collections[].collectionTypeinteger (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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.
activityIdsstringYesJSON array of the activities' integer IDs whose owners should be notified, e.g. "[13801,13802]".
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved sending these notifications.

Returns:

FieldTypeDescription
planIdinteger
actionstring (optional)"associate", "remove", or "notify-owners".
activityIdsarray 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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.
activityIdsstringYesJSON array of the activities' integer IDs to disassociate, e.g. "[13801,13802]".
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
planIdinteger
actionstring (optional)"associate", "remove", or "notify-owners".
activityIdsarray of integer
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.
entriesstringYesJSON 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}]".
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the exact grant list.

Returns:

FieldTypeDescription
planIdinteger
countinteger
itemsarray of ContentPlanAccessEntry
items[].objectIdinteger (optional)
items[].userIdinteger (optional)
items[].userNamestring (optional)
items[].hasEditRightboolean (optional)

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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.
collectionGuidstringYesThe linked DAM collection's GUID.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
planIdinteger
collectionGuidstring (optional)
unlinkedboolean
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


update_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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
planIdinteger
scsIdinteger (optional)PM's internal scs id for this content plan. New field surfaced now that PM's snapshot documents the full ContentPlan schema.
titlestring (optional)
descriptionstring (optional)
statusIdinteger (optional)[StaticLookupList] field resolved via PmFieldLabelCache (inlined on /metadata/ContentPlan), same mechanism as .
statusLabelstring (optional)
typeIdinteger (optional)[StaticLookupList] field, same resolution mechanism as .
typeLabelstring (optional)
beginDatestring (optional)
endDatestring (optional)
administratorIdinteger (optional)
administratorNamestring (optional)
modifiedUserIdinteger (optional)
modifiedUserNamestring (optional)
modifiedDatestring (optional)
backgroundThemestring (optional)
canReadboolean (optional)
canModifyboolean (optional)
canCreateActivityboolean (optional)
canModifyActivityboolean (optional)
collectionsarray of ContentPlanCollection (optional)DAM collections linked to this content plan. Null when the wire object carried none.
collections[].planIdinteger (optional)
collections[].collectionIdstring (optional)The linked DAM collection's GUID id.
collections[].collectionTypeinteger (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:

ParameterTypeRequiredDescription
contentPlanIdstringYesThe content plan's integer ID.
bodystringYesJSON object with the DAM collection mapping data (PM wire names).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
planIdinteger
collectionIdstring (optional)
collectionTypeinteger (optional)

Calendar Management​

Can change data · 4 tools · Group ID calendar-management

Needs: View Activities, Look Up PM Users, Groups & Roles

ToolWhat it does
get_calendar_activity_type_colorsRetrieves the configured display colors for each calendar activity type in Aprimo Marketing Operations.
get_shared_calendar_accessReturns the list of users a calendar is shared with and their access rights in Aprimo Marketing Operations.
share_calendarShares a calendar with a list of users and grants their access rights in Aprimo Marketing Operations.
update_calendar_activity_type_colorsUpdates 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:

FieldTypeDescription
countinteger
itemsarray of CalendarActivityTypeColorProjection
items[].rawobject (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:

ParameterTypeRequiredDescription
calendarIdstringYesThe calendar's integer ID.

Returns:

FieldTypeDescription
countinteger
itemsarray of CalendarAccessEntryProjection
items[].objectIdinteger
items[].userIdinteger
items[].userNamestring (optional)
items[].hasEditRightinteger
items[].avatarUrlstring (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:

ParameterTypeRequiredDescription
calendarIdstringYesThe calendar's integer ID to share.
bodystringYesJSON object with the calendar identifier and the access list entries to apply (PM wire names).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload.

Returns:

FieldTypeDescription
countinteger
itemsarray of CalendarAccessEntryProjection
items[].objectIdinteger
items[].userIdinteger
items[].userNamestring (optional)
items[].hasEditRightinteger
items[].avatarUrlstring (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:

ParameterTypeRequiredDescription
bodystringYesJSON object with the activity type color assignments to apply (PM wire names).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload.

Returns:

FieldTypeDescription
countinteger
itemsarray of CalendarActivityTypeColorProjection
items[].rawobject (optional)

View Projects​

Read-only · 9 tools (8 currently available) · Group ID view-projects

Needs: View Activities

ToolWhat it does
get_projectReturns a single Project by its integer ID from Aprimo Marketing Operations.
get_project_dam_collectionNot currently available. Returns the DAM collections linked to a Project, by the project's integer ID, in Aprimo Marketing Operations.
get_project_role_membersReturns the members of a project role, by project ID and project-role ID, in Aprimo Marketing Operations.
get_project_role_membershipsReturns all role memberships for a project, by the project's integer ID, in Aprimo Marketing Operations.
get_projects_for_activityLists the Projects that belong to an Activity (marketing campaign), by the activity's integer ID, in Aprimo Marketing Operations.
list_projectsLists Projects in Aprimo Marketing Operations, paged.
list_projects_displayReturns 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_attachmentLists the Projects that an attachment (by integer ID) is associated with, in Aprimo Marketing Operations, paged and sortable.
search_projectsSearches 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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID.

Returns:

FieldTypeDescription
projectIdinteger
titlestring (optional)
projectStatusIdinteger (optional)
projectStatusLabelstring (optional)
descriptionstring (optional)
beginDatestring (optional)
endDatestring (optional)
projectManagerIdinteger (optional)
projectManagerNamestring (optional)
activityIdinteger
activityNamestring (optional)
activityDeepLinkstring (optional)
deepLinkstring (optional)
workflowIdinteger (optional)PM's workflow id for this project. Nullable per the schema.
projectTypeIdinteger (optional)PM's project-type id. Nullable per the schema.
modifiedDatestring (optional)The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ).
modifiedUserIdinteger (optional)The user id who last modified the project.
timeZoneIdinteger (optional)PM's time-zone id for the project's dates.
projectScalingTypeIdinteger (optional)PM's project-scaling-type id.
associatedProjectIdinteger (optional)The id of another project this one is associated with, if any.
changeOrderboolean (optional)Whether this project represents a change order.
projectedEndDatestring (optional)Projected end date (distinct from the committed ).
baselineEndDatestring (optional)Baseline end date snapshot.
brandNamestring (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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID.

Returns:

FieldTypeDescription
projectIdinteger
countinteger
itemsarray of ProjectDamCollectionItem
items[].projectIdinteger
items[].collectionIdstring (optional)The DAM collection's GUID id.
items[].collectionNamestring (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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID.
projectRoleIdstringYesThe project role's integer ID.
includeUserNamebooleanNoWhen true, include each member's first/last name inline. Default false.

Returns:

FieldTypeDescription
projectIdinteger
projectRoleIdinteger
countinteger
itemsarray of ProjectRoleMemberItemProjection
items[].projectRoleMemberIdinteger (optional)
items[].projectRoleIdinteger
items[].userIdinteger (optional)
items[].firstNamestring (optional)
items[].lastNamestring (optional)
items[].projectRoleProjectRoleInfoProjection (optional)
items[].projectRole.projectRoleIdinteger
items[].projectRole.projectIdinteger
items[].projectRole.userRoleIdinteger

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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID.

Returns:

FieldTypeDescription
activityIdinteger (optional)
projectIdinteger
projectNamestring (optional)
rolesarray of ProjectRoleUserItemProjection
roles[].roleIdinteger (optional)
roles[].userIdinteger (optional)
roles[].userNamestring (optional)
roles[].userTokenIdinteger (optional)
roles[].userTokenstring (optional)
roles[].projectRoleIdinteger (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:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ProjectProjectionThe items returned in this response.
items[].projectIdinteger
items[].titlestring (optional)
items[].projectStatusIdinteger (optional)
items[].projectStatusLabelstring (optional)
items[].descriptionstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].projectManagerIdinteger (optional)
items[].projectManagerNamestring (optional)
items[].activityIdinteger
items[].activityNamestring (optional)
items[].activityDeepLinkstring (optional)
items[].deepLinkstring (optional)
items[].workflowIdinteger (optional)PM's workflow id for this project. Nullable per the schema.
items[].projectTypeIdinteger (optional)PM's project-type id. Nullable per the schema.
items[].modifiedDatestring (optional)The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ).
items[].modifiedUserIdinteger (optional)The user id who last modified the project.
items[].timeZoneIdinteger (optional)PM's time-zone id for the project's dates.
items[].projectScalingTypeIdinteger (optional)PM's project-scaling-type id.
items[].associatedProjectIdinteger (optional)The id of another project this one is associated with, if any.
items[].changeOrderboolean (optional)Whether this project represents a change order.
items[].projectedEndDatestring (optional)Projected end date (distinct from the committed ).
items[].baselineEndDatestring (optional)Baseline end date snapshot.
items[].brandNamestring (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:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by (e.g. 'ModifiedDate', 'Title'). Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.
titleFilterstringNoOptional case-insensitive title substring filter.
projectStatusLabelstringNoOptional 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:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ProjectProjectionThe items returned in this response.
items[].projectIdinteger
items[].titlestring (optional)
items[].projectStatusIdinteger (optional)
items[].projectStatusLabelstring (optional)
items[].descriptionstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].projectManagerIdinteger (optional)
items[].projectManagerNamestring (optional)
items[].activityIdinteger
items[].activityNamestring (optional)
items[].activityDeepLinkstring (optional)
items[].deepLinkstring (optional)
items[].workflowIdinteger (optional)PM's workflow id for this project. Nullable per the schema.
items[].projectTypeIdinteger (optional)PM's project-type id. Nullable per the schema.
items[].modifiedDatestring (optional)The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ).
items[].modifiedUserIdinteger (optional)The user id who last modified the project.
items[].timeZoneIdinteger (optional)PM's time-zone id for the project's dates.
items[].projectScalingTypeIdinteger (optional)PM's project-scaling-type id.
items[].associatedProjectIdinteger (optional)The id of another project this one is associated with, if any.
items[].changeOrderboolean (optional)Whether this project represents a change order.
items[].projectedEndDatestring (optional)Projected end date (distinct from the committed ).
items[].baselineEndDatestring (optional)Baseline end date snapshot.
items[].brandNamestring (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:

ParameterTypeRequiredDescription
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.
titleFilterstringNoOptional case-insensitive title substring filter.
projectStatusLabelstringNoOptional 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.
activityIdstringNoOptional linked activity's integer ID to narrow the display list to.

Returns:

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

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

Returns:

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

ParameterTypeRequiredDescription
querystringYesJSON-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}}'.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by (e.g. 'ModifiedDate', 'Title'). Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.
projectStatusLabelstringNoFilter 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.
projectManagerNamestringNoFilter 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.
attributeFiltersobject (map of string)NoFilter 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.
attributesPresentobject (map of boolean)NoFilter 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:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ProjectProjectionThe items returned in this response.
items[].projectIdinteger
items[].titlestring (optional)
items[].projectStatusIdinteger (optional)
items[].projectStatusLabelstring (optional)
items[].descriptionstring (optional)
items[].beginDatestring (optional)
items[].endDatestring (optional)
items[].projectManagerIdinteger (optional)
items[].projectManagerNamestring (optional)
items[].activityIdinteger
items[].activityNamestring (optional)
items[].activityDeepLinkstring (optional)
items[].deepLinkstring (optional)
items[].workflowIdinteger (optional)PM's workflow id for this project. Nullable per the schema.
items[].projectTypeIdinteger (optional)PM's project-type id. Nullable per the schema.
items[].modifiedDatestring (optional)The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ).
items[].modifiedUserIdinteger (optional)The user id who last modified the project.
items[].timeZoneIdinteger (optional)PM's time-zone id for the project's dates.
items[].projectScalingTypeIdinteger (optional)PM's project-scaling-type id.
items[].associatedProjectIdinteger (optional)The id of another project this one is associated with, if any.
items[].changeOrderboolean (optional)Whether this project represents a change order.
items[].projectedEndDatestring (optional)Projected end date (distinct from the committed ).
items[].baselineEndDatestring (optional)Baseline end date snapshot.
items[].brandNamestring (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

ToolWhat it does
cancel_projectDestructive. Cancels a Project in Aprimo Marketing Operations.
close_projectDestructive. Closes a Project in Aprimo Marketing Operations.
create_projectCreates a new Project in Aprimo Marketing Operations.
pause_projectDestructive. Pauses a Project in Aprimo Marketing Operations.
save_project_rolesAdds a role to a project, by the project's integer ID, in Aprimo Marketing Operations.
start_projectDestructive. Transitions a Project to started in Aprimo Marketing Operations.
update_projectUpdates an existing Project by its integer ID in Aprimo Marketing Operations.
update_project_role_membershipsReplaces 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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID to cancel.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
projectIdinteger
actionstring (optional)The state-change action performed: "start", "cancel", "pause", or "close".
succeededboolean
deepLinkstring (optional)UI deep link to the affected project.
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

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

Returns:

FieldTypeDescription
projectIdinteger
actionstring (optional)The state-change action performed: "start", "cancel", "pause", or "close".
succeededboolean
deepLinkstring (optional)UI deep link to the affected project.
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

ParameterTypeRequiredDescription
bodystringYesJSON 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.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the exact payload.

Returns:

FieldTypeDescription
projectIdinteger
titlestring (optional)
projectStatusIdinteger (optional)
projectStatusLabelstring (optional)
descriptionstring (optional)
beginDatestring (optional)
endDatestring (optional)
projectManagerIdinteger (optional)
projectManagerNamestring (optional)
activityIdinteger
activityNamestring (optional)
activityDeepLinkstring (optional)
deepLinkstring (optional)
workflowIdinteger (optional)PM's workflow id for this project. Nullable per the schema.
projectTypeIdinteger (optional)PM's project-type id. Nullable per the schema.
modifiedDatestring (optional)The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ).
modifiedUserIdinteger (optional)The user id who last modified the project.
timeZoneIdinteger (optional)PM's time-zone id for the project's dates.
projectScalingTypeIdinteger (optional)PM's project-scaling-type id.
associatedProjectIdinteger (optional)The id of another project this one is associated with, if any.
changeOrderboolean (optional)Whether this project represents a change order.
projectedEndDatestring (optional)Projected end date (distinct from the committed ).
baselineEndDatestring (optional)Baseline end date snapshot.
brandNamestring (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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID to pause.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
projectIdinteger
actionstring (optional)The state-change action performed: "start", "cancel", "pause", or "close".
succeededboolean
deepLinkstring (optional)UI deep link to the affected project.
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID.
bodystringYesJSON 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.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload.

Returns:

FieldTypeDescription
resultinteger (optional)
isValidboolean
validationErrorsarray of string (optional)
validationMessagesarray of ValidationMessageProjection (optional)
validationMessages[].formatResourceIdstring (optional)
validationMessages[].argumentResourceIdsarray of string (optional)
validationMessages[].formattedMessagestring (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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID to start.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error.
confirmedDestructivebooleanNoMust 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:

FieldTypeDescription
projectIdinteger
actionstring (optional)The state-change action performed: "start", "cancel", "pause", or "close".
succeededboolean
deepLinkstring (optional)UI deep link to the affected project.
Destructive operation

This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.


update_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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID.
bodystringYesJSON object with the fields to change (PM wire names). Omit fields you don't want to modify.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
projectIdinteger
titlestring (optional)
projectStatusIdinteger (optional)
projectStatusLabelstring (optional)
descriptionstring (optional)
beginDatestring (optional)
endDatestring (optional)
projectManagerIdinteger (optional)
projectManagerNamestring (optional)
activityIdinteger
activityNamestring (optional)
activityDeepLinkstring (optional)
deepLinkstring (optional)
workflowIdinteger (optional)PM's workflow id for this project. Nullable per the schema.
projectTypeIdinteger (optional)PM's project-type id. Nullable per the schema.
modifiedDatestring (optional)The project's last-modified timestamp (raw ISO-8601, not locale-formatted -- distinct from /, which route through ).
modifiedUserIdinteger (optional)The user id who last modified the project.
timeZoneIdinteger (optional)PM's time-zone id for the project's dates.
projectScalingTypeIdinteger (optional)PM's project-scaling-type id.
associatedProjectIdinteger (optional)The id of another project this one is associated with, if any.
changeOrderboolean (optional)Whether this project represents a change order.
projectedEndDatestring (optional)Projected end date (distinct from the committed ).
baselineEndDatestring (optional)Baseline end date snapshot.
brandNamestring (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:

ParameterTypeRequiredDescription
projectIdstringYesThe project's integer ID.
bodystringYesJSON object with the new role memberships (PM wire names, e.g. { "roles": [{ "roleId": 1, "userId": 42 }] }).
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
activityIdinteger (optional)
projectIdinteger
projectNamestring (optional)
rolesarray of ProjectRoleUserItemProjection
roles[].roleIdinteger (optional)
roles[].userIdinteger (optional)
roles[].userNamestring (optional)
roles[].userTokenIdinteger (optional)
roles[].userTokenstring (optional)
roles[].projectRoleIdinteger (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

ToolWhat it does
get_work_requestReturns a single work request by its integer ID in Aprimo Marketing Operations, including its hypermedia action links.
get_work_request_formReturns a single work request form by its activity id in Aprimo Marketing Operations.
list_work_request_categoriesLists work request categories in Aprimo Marketing Operations.
list_work_request_formsReturns a paginated list of work request forms, without field data, in Aprimo Marketing Operations.
list_work_request_forms_by_categoryReturns a paginated list of work request forms in the given category (siteId), without field data, in Aprimo Marketing Operations.
list_work_request_reviewsLists the requesting user's assigned work request reviews in Aprimo Marketing Operations, paged.
list_work_requestsLists the requesting user's work requests in Aprimo Marketing Operations, paged.
search_work_request_formsSearches work request forms in Aprimo Marketing Operations using a JSON query body, returns a paginated, sortable result set.
search_work_requestsSearches 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:

ParameterTypeRequiredDescription
idstringYesThe work request's integer ID.

Returns:

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

ParameterTypeRequiredDescription
activityIdstringYesThe work request form's activity ID.

Returns:

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

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

list_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:

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

Returns:

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

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:

ParameterTypeRequiredDescription
siteIdstringYesThe work request category's integer ID (siteId).
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).

Returns:

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

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:

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

Returns:

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

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:

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

Returns:

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

search_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:

ParameterTypeRequiredDescription
querystringYesJSON object with the search query PM expects (PM query DSL). Pass "{}" for an unfiltered search.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

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

search_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:

ParameterTypeRequiredDescription
querystringYesJSON object with the search query PM expects (PM query DSL). Pass "{}" for an unfiltered search.
limitintegerNoMaximum number of results to return (1–50, default 20).
offsetintegerNoNumber of results to skip for pagination (default 0).
sortFieldstringNoOptional field name to sort by. Omit for default ordering.
sortAscendingbooleanNoSort direction. true = ascending (default), false = descending.

Returns:

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