Skip to main content

Calendar

Tools for calendar sharing and the colours assigned to activity types.

This page covers 4 tools, all of them available on request rather than in the default tool list.

How to read this page
  • Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
  • Both statuses work identically when called. Status affects discovery, not capability or authorization.
  • Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. See the MCP Tool Permission Map.
  • Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both confirmed and confirmedDestructive to true.
  • Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Why isn't every tool in the default list?

Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.

Tools at a Glance

ToolStatusWhat it does
get_calendar_activity_type_colorsOn requestRetrieves the configured display colors for each calendar activity type in Aprimo Marketing Operations.
get_shared_calendar_accessOn requestReturns the list of users a calendar is shared with and their access rights in Aprimo Marketing Operations.
share_calendarOn requestShares a calendar with a list of users and grants their access rights in Aprimo Marketing Operations.
update_calendar_activity_type_colorsOn requestUpdates the display colors assigned to calendar activity types in Aprimo Marketing Operations.

get_calendar_activity_type_colors

Available on request

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

Available on request

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

Available on request

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

Available on request

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)