Chatboards
Tools for chatboards attached to Productivity Management objects — reading and posting messages, filters, statuses, and access.
This page covers 14 tools, all of them available on request rather than in the default tool list, and 1 destructive.
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
create_chatboard_for_object | On request | Creates a chatboard for the specified object in Aprimo Marketing Operations. |
create_chatboard_message | On request | Creates a chatboard message in Aprimo Marketing Operations and returns the persisted message. |
delete_chatboard | On request | Destructive. Permanently deletes a chatboard by its integer ID in Aprimo Marketing Operations. |
get_chatboard | On request | Returns a single chatboard by its integer ID in Aprimo Marketing Operations, including its hypermedia action links (messages, parent, delete, read-all). |
get_chatboard_by_object | On request | Returns the chatboard for the given id and object, in Aprimo Marketing Operations. |
get_chatboard_from_object | On request | Returns the chatboard associated with the given parent object in Aprimo Marketing Operations. |
get_chatboard_legacy_links | On request | Returns the legacy links associated with the given chatboard object, by its integer ID, in Aprimo Marketing Operations. |
get_project_chat_access | On request | Determines whether the current user has chat access to a project in Aprimo Marketing Operations. |
list_chatboard_filters | On request | Lists the filters available for chatboards in Aprimo Marketing Operations. |
list_chatboard_messages | On request | Returns a chatboard's messages, by the chatboard's integer ID, in Aprimo Marketing Operations. |
list_chatboard_statuses | On request | Returns chatboard statuses for the given object type, by its integer ID, in Aprimo Marketing Operations. |
read_all_chatboard_messages | On request | Marks all messages in the specified chatboard as read for the current user, in Aprimo Marketing Operations. |
read_all_inbox_messages | On request | Marks all messages as read for the current user, across all of their chatboards, in Aprimo Marketing Operations. |
read_chatboard_message | On request | Marks the specified message as read for the current user in Aprimo Marketing Operations. |
create_chatboard_for_object
Available on request
Creates a chatboard for the specified object in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact object being chat-enabled. Returns the created chatboard.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectTypeId | string | Yes | The parent object's integer type ID. |
objectId | string | Yes | The parent object's integer ID. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved creating the chatboard. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
create_chatboard_message
Available on request
Creates a chatboard message in Aprimo Marketing Operations and returns the persisted message. Requires confirmed=true after showing the user the exact payload.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new message's data (PM wire names), including the target chatboard's id. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
text | string (optional) | The message body/text, when present under any of the common wire names. |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
delete_chatboard
Available on request · Destructive
Permanently deletes a chatboard by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact chatboard with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
chatboardId | string | Yes | The chatboard's integer ID to delete. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a chatboard is permanent and cannot be undone. Set only after stating the exact chatboard to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
chatboardId | integer | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_chatboard
Available on request
Returns a single chatboard by its integer ID in Aprimo Marketing Operations, including its hypermedia action links (messages, parent, delete, read-all). Not a lookup by object (get_chatboard_by_object or get_chatboard_from_object) or its legacy links (get_chatboard_legacy_links).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
chatboardId | string | Yes | The chatboard's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
get_chatboard_by_object
Available on request
Returns the chatboard for the given id and object, in Aprimo Marketing Operations. Important: per PM's own documented behavior, passing chatboardId=0 can auto-create a new chatboard for the object (server-controlled, not observable or suppressible from here) -- when chatboardId=0, confirmed=true is required after telling the user a chatboard may be created. Any non-zero chatboardId is a pure read, no confirmation needed.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
chatboardId | string | Yes | The chatboard's integer ID, or 0 to look up/possibly auto-create one for the object below. |
objectTypeId | string | Yes | The parent object's integer type ID. |
objectId | string | Yes | The parent object's integer ID. |
confirmed | boolean | No | Required (must be true) only when chatboardId=0, since that path can auto-create a chatboard. Ignored for any non-zero chatboardId. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
get_chatboard_from_object
Available on request
Returns the chatboard associated with the given parent object in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectId | string | Yes | The parent object's integer ID. |
objectTypeId | string | Yes | The parent object's integer type ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
name | string (optional) | |
raw | object (optional) | The complete wire object, verbatim, for full fidelity beyond the defensively-extracted fields above. |
get_chatboard_legacy_links
Available on request
Returns the legacy links associated with the given chatboard object, by its integer ID, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The object's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
get_project_chat_access
Available on request
Determines whether the current user has chat access to a project in Aprimo Marketing Operations.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
projectId | integer | |
hasAccess | boolean |
list_chatboard_filters
Available on request
Lists the filters available for chatboards in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters: none.
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_chatboard_messages
Available on request
Returns a chatboard's messages, by the chatboard's integer ID, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
chatboardId | string | Yes | The chatboard's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
list_chatboard_statuses
Available on request
Returns chatboard statuses for the given object type, by its integer ID, in Aprimo Marketing Operations.
Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
objectTypeId | string | Yes | The object type's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer (optional) | |
raw | object (optional) |
read_all_chatboard_messages
Available on request
Marks all messages in the specified chatboard as read for the current user, in Aprimo Marketing Operations. Requires confirmed=true after confirming the exact chatboard with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
chatboardId | string | Yes | The chatboard's integer ID. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved marking all messages read. |
Returns:
| Field | Type | Description |
|---|---|---|
chatboardId | integer (optional) | |
messageId | integer (optional) | |
action | string (optional) | The action performed: "read", "read-all-messages", or "read-all-inbox-messages". |
succeeded | boolean | |
raw | object (optional) | The complete wire response, verbatim, since the real response shape is unverified. |
read_all_inbox_messages
Available on request
Marks all messages as read for the current user, across all of their chatboards, in Aprimo Marketing Operations. Requires confirmed=true after confirming this affects every chatboard the user is in, not just one.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved marking all inbox messages read. |
Returns:
| Field | Type | Description |
|---|---|---|
chatboardId | integer (optional) | |
messageId | integer (optional) | |
action | string (optional) | The action performed: "read", "read-all-messages", or "read-all-inbox-messages". |
succeeded | boolean | |
raw | object (optional) | The complete wire response, verbatim, since the real response shape is unverified. |
read_chatboard_message
Available on request
Marks the specified message as read for the current user in Aprimo Marketing Operations. Requires confirmed=true after confirming the exact message with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
messageId | string | Yes | The message's integer ID to mark as read. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved marking the message read. |
Returns:
| Field | Type | Description |
|---|---|---|
chatboardId | integer (optional) | |
messageId | integer (optional) | |
action | string (optional) | The action performed: "read", "read-all-messages", or "read-all-inbox-messages". |
succeeded | boolean | |
raw | object (optional) | The complete wire response, verbatim, since the real response shape is unverified. |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent