Generic Objects
Tools for the five configurable generic object types (alpha through echo) — tenant-defined records that extend Productivity Management with custom object models.
This page covers 32 tools, all of them available on request rather than in the default tool list, and 5 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_generic_object_alpha | On request | Creates a new GenericObjectAlpha record in Aprimo Marketing Operations. |
create_generic_object_bravo | On request | Creates a new GenericObjectBravo record in Aprimo Marketing Operations. |
create_generic_object_charlie | On request | Creates a new GenericObjectCharlie record in Aprimo Marketing Operations. |
create_generic_object_delta | On request | Creates a new GenericObjectDelta record in Aprimo Marketing Operations. |
create_generic_object_echo | On request | Creates a new GenericObjectEcho record in Aprimo Marketing Operations. |
delete_generic_object_alpha | On request | Destructive. Permanently deletes a GenericObjectAlpha record by its integer ID in Aprimo Marketing Operations. |
delete_generic_object_bravo | On request | Destructive. Permanently deletes a GenericObjectBravo record by its integer ID in Aprimo Marketing Operations. |
delete_generic_object_charlie | On request | Destructive. Permanently deletes a GenericObjectCharlie record by its integer ID in Aprimo Marketing Operations. |
delete_generic_object_delta | On request | Destructive. Permanently deletes a GenericObjectDelta record by its integer ID in Aprimo Marketing Operations. |
delete_generic_object_echo | On request | Destructive. Permanently deletes a GenericObjectEcho record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_alpha | On request | Returns a single GenericObjectAlpha record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_bravo | On request | Returns a single GenericObjectBravo record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_charlie | On request | Returns a single GenericObjectCharlie record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_delta | On request | Returns a single GenericObjectDelta record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_echo | On request | Returns a single GenericObjectEcho record by its integer ID in Aprimo Marketing Operations. |
list_generic_object_alpha | On request | Lists GenericObjectAlpha records in Aprimo Marketing Operations, paged and unfiltered. |
list_generic_object_alpha_for_activity | On request | Lists the GenericObjectAlpha records associated with a given activity, by the activity's integer ID, in Aprimo Marketing Operations, paged. |
list_generic_object_bravo | On request | Lists GenericObjectBravo records in Aprimo Marketing Operations, paged and unfiltered. |
list_generic_object_bravo_for_project | On request | Lists the GenericObjectBravo records associated with a given project, by the project's integer ID, in Aprimo Marketing Operations, paged. |
list_generic_object_charlie | On request | Lists GenericObjectCharlie records in Aprimo Marketing Operations, paged and unfiltered. |
list_generic_object_delta | On request | Lists GenericObjectDelta records in Aprimo Marketing Operations, paged and unfiltered. |
list_generic_object_echo | On request | Lists GenericObjectEcho records in Aprimo Marketing Operations, paged and unfiltered. |
search_generic_object_alpha | On request | Searches GenericObjectAlpha records in Aprimo Marketing Operations by name, paged. |
search_generic_object_bravo | On request | Searches GenericObjectBravo records in Aprimo Marketing Operations by name, paged. |
search_generic_object_charlie | On request | Searches GenericObjectCharlie records in Aprimo Marketing Operations by name, paged. |
search_generic_object_delta | On request | Searches GenericObjectDelta records in Aprimo Marketing Operations by name, paged. |
search_generic_object_echo | On request | Searches GenericObjectEcho records in Aprimo Marketing Operations by name, paged. |
update_generic_object_alpha | On request | Updates an existing GenericObjectAlpha record by its integer ID in Aprimo Marketing Operations. |
update_generic_object_bravo | On request | Updates an existing GenericObjectBravo record by its integer ID in Aprimo Marketing Operations. |
update_generic_object_charlie | On request | Updates an existing GenericObjectCharlie record by its integer ID in Aprimo Marketing Operations. |
update_generic_object_delta | On request | Updates an existing GenericObjectDelta record by its integer ID in Aprimo Marketing Operations. |
update_generic_object_echo | On request | Updates an existing GenericObjectEcho record by its integer ID in Aprimo Marketing Operations. |
create_generic_object_alpha
Available on request
Creates a new GenericObjectAlpha record in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new record's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including the extendedAttributes/ multipleValueExtendedAttributes arrays this projection does not surface as typed properties. See the class remarks. |
create_generic_object_bravo
Available on request
Creates a new GenericObjectBravo record in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new record's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
create_generic_object_charlie
Available on request
Creates a new GenericObjectCharlie record in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new record's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
create_generic_object_delta
Available on request
Creates a new GenericObjectDelta record in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new record's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
create_generic_object_echo
Available on request
Creates a new GenericObjectEcho record in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new record's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
delete_generic_object_alpha
Available on request · Destructive
Permanently deletes a GenericObjectAlpha record by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact record with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record'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 this record is permanent and cannot be undone. Set only after stating the exact record to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
delete_generic_object_bravo
Available on request · Destructive
Permanently deletes a GenericObjectBravo record by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact record with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record'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 this record is permanent and cannot be undone. Set only after stating the exact record to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
delete_generic_object_charlie
Available on request · Destructive
Permanently deletes a GenericObjectCharlie record by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact record with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record'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 this record is permanent and cannot be undone. Set only after stating the exact record to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
delete_generic_object_delta
Available on request · Destructive
Permanently deletes a GenericObjectDelta record by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact record with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record'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 this record is permanent and cannot be undone. Set only after stating the exact record to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
delete_generic_object_echo
Available on request · Destructive
Permanently deletes a GenericObjectEcho record by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact record with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record'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 this record is permanent and cannot be undone. Set only after stating the exact record to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | 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_generic_object_alpha
Available on request
Returns a single GenericObjectAlpha record 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 record's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including the extendedAttributes/ multipleValueExtendedAttributes arrays this projection does not surface as typed properties. See the class remarks. |
get_generic_object_bravo
Available on request
Returns a single GenericObjectBravo record 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 record's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
get_generic_object_charlie
Available on request
Returns a single GenericObjectCharlie record 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 record's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
get_generic_object_delta
Available on request
Returns a single GenericObjectDelta record 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 record's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
get_generic_object_echo
Available on request
Returns a single GenericObjectEcho record 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 record's integer ID. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
list_generic_object_alpha
Available on request
Lists GenericObjectAlpha records in Aprimo Marketing Operations, paged and unfiltered. Use search_generic_object_alpha when you need to filter, use this to browse.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectAlphaProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- including the extendedAttributes/ multipleValueExtendedAttributes arrays this projection does not surface as typed properties. See the class remarks. |
list_generic_object_alpha_for_activity
Available on request
Lists the GenericObjectAlpha records associated with a given activity, by the activity's integer ID, in Aprimo Marketing Operations, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
activityId | string | Yes | The activity's integer ID. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectAlphaProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- including the extendedAttributes/ multipleValueExtendedAttributes arrays this projection does not surface as typed properties. See the class remarks. |
list_generic_object_bravo
Available on request
Lists GenericObjectBravo records in Aprimo Marketing Operations, paged and unfiltered. Use search_generic_object_bravo when you need to filter, use this to browse.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectBravoProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
list_generic_object_bravo_for_project
Available on request
Lists the GenericObjectBravo records associated with a given project, by the project's integer ID, in Aprimo Marketing Operations, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project's integer ID. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectBravoProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
list_generic_object_charlie
Available on request
Lists GenericObjectCharlie records in Aprimo Marketing Operations, paged and unfiltered. Use search_generic_object_charlie when you need to filter, use this to browse.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectCharlieProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
list_generic_object_delta
Available on request
Lists GenericObjectDelta records in Aprimo Marketing Operations, paged and unfiltered. Use search_generic_object_delta when you need to filter, use this to browse.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectDeltaProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
list_generic_object_echo
Available on request
Lists GenericObjectEcho records in Aprimo Marketing Operations, paged and unfiltered. Use search_generic_object_echo when you need to filter, use this to browse.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectEchoProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
search_generic_object_alpha
Available on request
Searches GenericObjectAlpha records in Aprimo Marketing Operations by name, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
nameFilter | string | No | Optional case-insensitive substring filter on the record's name. Omit to match all records. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectAlphaProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) | The complete wire object, verbatim -- including the extendedAttributes/ multipleValueExtendedAttributes arrays this projection does not surface as typed properties. See the class remarks. |
search_generic_object_bravo
Available on request
Searches GenericObjectBravo records in Aprimo Marketing Operations by name, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
nameFilter | string | No | Optional case-insensitive substring filter on the record's name. Omit to match all records. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectBravoProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
search_generic_object_charlie
Available on request
Searches GenericObjectCharlie records in Aprimo Marketing Operations by name, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
nameFilter | string | No | Optional case-insensitive substring filter on the record's name. Omit to match all records. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectCharlieProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
search_generic_object_delta
Available on request
Searches GenericObjectDelta records in Aprimo Marketing Operations by name, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
nameFilter | string | No | Optional case-insensitive substring filter on the record's name. Omit to match all records. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectDeltaProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
search_generic_object_echo
Available on request
Searches GenericObjectEcho records in Aprimo Marketing Operations by name, paged.
Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
nameFilter | string | No | Optional case-insensitive substring filter on the record's name. Omit to match all records. |
limit | integer | No | Maximum number of results to return (1–50, default 20). |
offset | integer | No | Number of results to skip for pagination (default 0). |
sortField | string | No | Optional field name to sort by. Omit for default ordering. |
sortAscending | boolean | No | Sort direction. true = ascending (default), false = descending. |
Returns:
| Field | Type | Description |
|---|---|---|
collectionName | string (optional) | Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped. |
totalRecords | integer | Total record count across all pages — from the wire's _total. |
count | integer | Number of items returned in this response (i.e. Items.Count; precomputed for the llm). |
offset | integer | The offset that was used to produce this page (echoes the caller's offset, clamped to ≥0). |
hasMore | boolean | True when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page. |
nextOffset | integer (optional) | Offset to pass on the next request to continue. Null when is false. |
items | array of GenericObjectEchoProjection | The items returned in this response. |
items[].id | integer | |
items[].name | string (optional) | |
items[].description | string (optional) | |
items[].createdBy | integer (optional) | |
items[].createdDate | string (optional) | |
items[].modifiedBy | integer (optional) | |
items[].modifiedDate | string (optional) | |
items[].relatedObjectId | integer (optional) | |
items[].status | integer (optional) | |
items[].raw | object (optional) |
update_generic_object_alpha
Available on request
Updates an existing GenericObjectAlpha record 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 record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) | The complete wire object, verbatim -- including the extendedAttributes/ multipleValueExtendedAttributes arrays this projection does not surface as typed properties. See the class remarks. |
update_generic_object_bravo
Available on request
Updates an existing GenericObjectBravo record 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 record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
update_generic_object_charlie
Available on request
Updates an existing GenericObjectCharlie record 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 record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
update_generic_object_delta
Available on request
Updates an existing GenericObjectDelta record 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 record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
update_generic_object_echo
Available on request
Updates an existing GenericObjectEcho record 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 record.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The record's integer ID. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string (optional) | |
description | string (optional) | |
createdBy | integer (optional) | |
createdDate | string (optional) | |
modifiedBy | integer (optional) | |
modifiedDate | string (optional) | |
relatedObjectId | integer (optional) | |
status | integer (optional) | |
raw | object (optional) |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent