Generic Objects
The five tenant-defined generic object types. Each type has its own group, and your tenant's own labels are substituted at runtime.
This area has 5 groups and 32 tools.
- Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
- Needs. Enabling a group also enables every group it needs. Each group below lists them.
- Read-only groups are intended for look-up access without the ability to change data.
- Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Not currently available tools are registered but are not offered in any tool list at this time.
- Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Groups in this area
| Group | Access | Needs | Tools |
|---|---|---|---|
| Generic Object: Alpha (activity-linked) | Can change data | Look Up PM Reference Data, View Activities | 7 |
| Generic Object: Bravo (project-linked) | Can change data | Look Up PM Reference Data, View Projects | 7 |
| Generic Object: Charlie | Can change data | Look Up PM Reference Data | 6 |
| Generic Object: Delta | Can change data | Look Up PM Reference Data | 6 |
| Generic Object: Echo | Can change data | Look Up PM Reference Data | 6 |
Generic Object: Alpha (activity-linked)
Can change data · 7 tools · Group ID generic-object-alpha
Needs: Look Up PM Reference Data, View Activities
| Tool | What it does |
|---|---|
create_generic_object_alpha | Creates a new GenericObjectAlpha record in Aprimo Marketing Operations. |
delete_generic_object_alpha | Destructive. Permanently deletes a GenericObjectAlpha record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_alpha | Returns a single GenericObjectAlpha record by its integer ID in Aprimo Marketing Operations. |
list_generic_object_alpha | Lists GenericObjectAlpha records in Aprimo Marketing Operations, paged and unfiltered. |
list_generic_object_alpha_for_activity | Lists the GenericObjectAlpha records associated with a given activity, by the activity's integer ID, in Aprimo Marketing Operations, paged. |
search_generic_object_alpha | Searches GenericObjectAlpha records in Aprimo Marketing Operations by name, paged. |
update_generic_object_alpha | Updates an existing GenericObjectAlpha record by its integer ID in Aprimo Marketing Operations. |
create_generic_object_alpha
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. |
delete_generic_object_alpha
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.
get_generic_object_alpha
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. |
list_generic_object_alpha
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
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. |
search_generic_object_alpha
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. |
update_generic_object_alpha
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. |
Generic Object: Bravo (project-linked)
Can change data · 7 tools · Group ID generic-object-bravo
Needs: Look Up PM Reference Data, View Projects
| Tool | What it does |
|---|---|
create_generic_object_bravo | Creates a new GenericObjectBravo record in Aprimo Marketing Operations. |
delete_generic_object_bravo | Destructive. Permanently deletes a GenericObjectBravo record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_bravo | Returns a single GenericObjectBravo record by its integer ID in Aprimo Marketing Operations. |
list_generic_object_bravo | Lists GenericObjectBravo records in Aprimo Marketing Operations, paged and unfiltered. |
list_generic_object_bravo_for_project | Lists the GenericObjectBravo records associated with a given project, by the project's integer ID, in Aprimo Marketing Operations, paged. |
search_generic_object_bravo | Searches GenericObjectBravo records in Aprimo Marketing Operations by name, paged. |
update_generic_object_bravo | Updates an existing GenericObjectBravo record by its integer ID in Aprimo Marketing Operations. |
create_generic_object_bravo
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) |
delete_generic_object_bravo
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.
get_generic_object_bravo
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) |
list_generic_object_bravo
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
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) |
search_generic_object_bravo
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) |
update_generic_object_bravo
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) |
Generic Object: Charlie
Can change data · 6 tools · Group ID generic-object-charlie
Needs: Look Up PM Reference Data
| Tool | What it does |
|---|---|
create_generic_object_charlie | Creates a new GenericObjectCharlie record in Aprimo Marketing Operations. |
delete_generic_object_charlie | Destructive. Permanently deletes a GenericObjectCharlie record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_charlie | Returns a single GenericObjectCharlie record by its integer ID in Aprimo Marketing Operations. |
list_generic_object_charlie | Lists GenericObjectCharlie records in Aprimo Marketing Operations, paged and unfiltered. |
search_generic_object_charlie | Searches GenericObjectCharlie records in Aprimo Marketing Operations by name, paged. |
update_generic_object_charlie | Updates an existing GenericObjectCharlie record by its integer ID in Aprimo Marketing Operations. |
create_generic_object_charlie
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) |
delete_generic_object_charlie
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.
get_generic_object_charlie
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) |
list_generic_object_charlie
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) |
search_generic_object_charlie
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) |
update_generic_object_charlie
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) |
Generic Object: Delta
Can change data · 6 tools · Group ID generic-object-delta
Needs: Look Up PM Reference Data
| Tool | What it does |
|---|---|
create_generic_object_delta | Creates a new GenericObjectDelta record in Aprimo Marketing Operations. |
delete_generic_object_delta | Destructive. Permanently deletes a GenericObjectDelta record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_delta | Returns a single GenericObjectDelta record by its integer ID in Aprimo Marketing Operations. |
list_generic_object_delta | Lists GenericObjectDelta records in Aprimo Marketing Operations, paged and unfiltered. |
search_generic_object_delta | Searches GenericObjectDelta records in Aprimo Marketing Operations by name, paged. |
update_generic_object_delta | Updates an existing GenericObjectDelta record by its integer ID in Aprimo Marketing Operations. |
create_generic_object_delta
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) |
delete_generic_object_delta
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.
get_generic_object_delta
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) |
list_generic_object_delta
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) |
search_generic_object_delta
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) |
update_generic_object_delta
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) |
Generic Object: Echo
Can change data · 6 tools · Group ID generic-object-echo
Needs: Look Up PM Reference Data
| Tool | What it does |
|---|---|
create_generic_object_echo | Creates a new GenericObjectEcho record in Aprimo Marketing Operations. |
delete_generic_object_echo | Destructive. Permanently deletes a GenericObjectEcho record by its integer ID in Aprimo Marketing Operations. |
get_generic_object_echo | Returns a single GenericObjectEcho record by its integer ID in Aprimo Marketing Operations. |
list_generic_object_echo | Lists GenericObjectEcho records in Aprimo Marketing Operations, paged and unfiltered. |
search_generic_object_echo | Searches GenericObjectEcho records in Aprimo Marketing Operations by name, paged. |
update_generic_object_echo | Updates an existing GenericObjectEcho record by its integer ID in Aprimo Marketing Operations. |
create_generic_object_echo
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_echo
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_echo
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_echo
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_echo
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_echo
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) |