Skip to main content

Offer Manager

Segment audiences into activity cells and define the treatments and offers that go to them.

This area has 2 groups and 32 tools, 29 of them currently available.

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

Groups in this area​

GroupAccessNeedsTools
Segment Audiences (Activity Cells)Can change dataView Activities, Look Up PM Reference Data12
Define Treatments & OffersCan change dataSegment Audiences (Activity Cells), Look Up PM Reference Data20

Segment Audiences (Activity Cells)​

Can change data · 12 tools (9 currently available) · Group ID segment-audiences-cells

Needs: View Activities, Look Up PM Reference Data

ToolWhat it does
create_activity_cellCreates a new activity cell in Aprimo Marketing Operations.
create_activity_cell_treatmentCreates a new activity cell treatment in Aprimo Marketing Operations.
delete_activity_cellDestructive. Permanently deletes an activity cell by its ID in Aprimo Marketing Operations.
delete_activity_cell_treatmentDestructive. Permanently deletes an activity cell treatment by its ID in Aprimo Marketing Operations.
get_activity_cellReturns a single activity cell by its ID in Aprimo Marketing Operations.
get_activity_cell_integrationNot currently available. Returns an activity cell's integration record, by the activity cell's integer ID, in Aprimo Marketing Operations.
get_activity_cell_treatmentReturns a single activity cell treatment by its ID in Aprimo Marketing Operations.
list_activity_cell_treatmentsLists the cell treatments for a given activity cell, by the activity cell's integer ID, in Aprimo Marketing Operations, paged.
list_activity_cellsLists the activity cells for a given activity, by the activity's integer ID, in Aprimo Marketing Operations, paged.
update_activity_cellUpdates an existing activity cell by its ID in Aprimo Marketing Operations.
update_activity_cell_integrationNot currently available. Updates an activity cell's integration record, by the activity cell's integer ID, in Aprimo Marketing Operations.
update_activity_cell_treatmentNot currently available. Updates an existing activity cell treatment by its ID in Aprimo Marketing Operations.

create_activity_cell​

Creates a new activity cell in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created activity cell.

Parameters:

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

Returns:

FieldTypeDescription
idinteger
activityCellIdinteger (optional)PM's own id field for this resource (activityCellId) -- is set from this after deserialization.
titlestring (optional)
championCellIdinteger (optional)
descriptionstring (optional)
activityIdinteger (optional)
codestring (optional)
cellTypeIdinteger (optional)
activityOfferIdinteger (optional)
sourceCodestring (optional)
estimatedQuantityinteger (optional)
actualQuantityinteger (optional)
actualResponseinteger (optional)
sequenceinteger (optional)
estimatedRevenuenumber (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the typed fields above.

create_activity_cell_treatment​

Creates a new activity cell treatment in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created activity cell treatment.

Parameters:

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

Returns:

FieldTypeDescription
idinteger
activityCellTreatmentIdinteger (optional)PM's own id field for this resource (activityCellTreatmentId) -- is set from this after deserialization.
activityCellIdinteger (optional)The parent activity cell (ActivityCellTools) this cell treatment belongs to.
channelIdinteger (optional)
activityTreatmentIdinteger (optional)The activity treatment (ActivityTreatmentTools) this cell treatment references.
activityWaveIdinteger (optional)
cellPercentagenumber (optional)
estResponseRatePercentnumber (optional)
sequenceinteger (optional)
rawobject (optional)

delete_activity_cell​

Destructive

Permanently deletes an activity cell by its ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact activity cell with the user.

Parameters:

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

Returns:

FieldTypeDescription
idstring
deletedboolean
Destructive operation

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


delete_activity_cell_treatment​

Destructive

Permanently deletes an activity cell treatment by its ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact activity cell treatment with the user.

Parameters:

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

Returns:

FieldTypeDescription
idstring
deletedboolean
Destructive operation

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


get_activity_cell​

Returns a single activity cell by its ID in Aprimo Marketing Operations. Not its integration record (get_activity_cell_integration) or treatment (get_activity_cell_treatment).

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
activityCellIdstringYesThe activity cell's ID.

Returns:

FieldTypeDescription
idinteger
activityCellIdinteger (optional)PM's own id field for this resource (activityCellId) -- is set from this after deserialization.
titlestring (optional)
championCellIdinteger (optional)
descriptionstring (optional)
activityIdinteger (optional)
codestring (optional)
cellTypeIdinteger (optional)
activityOfferIdinteger (optional)
sourceCodestring (optional)
estimatedQuantityinteger (optional)
actualQuantityinteger (optional)
actualResponseinteger (optional)
sequenceinteger (optional)
estimatedRevenuenumber (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the typed fields above.

get_activity_cell_integration​

Not currently available

Returns an activity cell's integration record, by the activity cell's integer ID, in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
activityCellIdstringYesThe activity cell's integer ID.

Returns:

FieldTypeDescription
activityCellIdinteger (optional)
executionIdstring (optional)
executionNamestring (optional)
executionStatusstring (optional)
executionVersionstring (optional)
executionLinkstring (optional)
lastSyncTimestring (optional)

get_activity_cell_treatment​

Returns a single activity cell treatment by its ID in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
activityCellTreatmentIdstringYesThe activity cell treatment's ID.

Returns:

FieldTypeDescription
idinteger
activityCellTreatmentIdinteger (optional)PM's own id field for this resource (activityCellTreatmentId) -- is set from this after deserialization.
activityCellIdinteger (optional)The parent activity cell (ActivityCellTools) this cell treatment belongs to.
channelIdinteger (optional)
activityTreatmentIdinteger (optional)The activity treatment (ActivityTreatmentTools) this cell treatment references.
activityWaveIdinteger (optional)
cellPercentagenumber (optional)
estResponseRatePercentnumber (optional)
sequenceinteger (optional)
rawobject (optional)

list_activity_cell_treatments​

Lists the cell treatments for a given activity cell, by the activity cell's integer ID, in Aprimo Marketing Operations, paged.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ActivityCellTreatmentProjectionThe items returned in this response.
items[].idinteger
items[].activityCellTreatmentIdinteger (optional)PM's own id field for this resource (activityCellTreatmentId) -- is set from this after deserialization.
items[].activityCellIdinteger (optional)The parent activity cell (ActivityCellTools) this cell treatment belongs to.
items[].channelIdinteger (optional)
items[].activityTreatmentIdinteger (optional)The activity treatment (ActivityTreatmentTools) this cell treatment references.
items[].activityWaveIdinteger (optional)
items[].cellPercentagenumber (optional)
items[].estResponseRatePercentnumber (optional)
items[].sequenceinteger (optional)
items[].rawobject (optional)

list_activity_cells​

Lists the activity cells for 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:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ActivityCellProjectionThe items returned in this response.
items[].idinteger
items[].activityCellIdinteger (optional)PM's own id field for this resource (activityCellId) -- is set from this after deserialization.
items[].titlestring (optional)
items[].championCellIdinteger (optional)
items[].descriptionstring (optional)
items[].activityIdinteger (optional)
items[].codestring (optional)
items[].cellTypeIdinteger (optional)
items[].activityOfferIdinteger (optional)
items[].sourceCodestring (optional)
items[].estimatedQuantityinteger (optional)
items[].actualQuantityinteger (optional)
items[].actualResponseinteger (optional)
items[].sequenceinteger (optional)
items[].estimatedRevenuenumber (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (optional)
items[].rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the typed fields above.

update_activity_cell​

Updates an existing activity cell by its ID in Aprimo Marketing Operations. Not a true partial update -- PM validates the body against the full activity cell record and rejects it ("Required property ... not found") if any required field (e.g. activityId, title) is missing, even ones you aren't changing. Call get_activity_cell first, merge your changes into the full record, and send that. Requires confirmed=true after showing the user the exact changes. Returns the updated activity cell.

Parameters:

ParameterTypeRequiredDescription
activityCellIdstringYesThe activity cell's ID.
bodystringYesJSON object with the full activity cell record (PM wire names), not just the changed fields -- see the tool description.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
idinteger
activityCellIdinteger (optional)PM's own id field for this resource (activityCellId) -- is set from this after deserialization.
titlestring (optional)
championCellIdinteger (optional)
descriptionstring (optional)
activityIdinteger (optional)
codestring (optional)
cellTypeIdinteger (optional)
activityOfferIdinteger (optional)
sourceCodestring (optional)
estimatedQuantityinteger (optional)
actualQuantityinteger (optional)
actualResponseinteger (optional)
sequenceinteger (optional)
estimatedRevenuenumber (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
rawobject (optional)The complete wire object, verbatim, for full fidelity beyond the typed fields above.

update_activity_cell_integration​

Not currently available

Updates an activity cell's integration record, by the activity cell's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact changes. PM's snapshot declares no response body for this operation, so success is echoed back without a re-fetch.

Parameters:

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

Returns:

FieldTypeDescription
activityCellIdinteger
succeededboolean

update_activity_cell_treatment​

Not currently available

Updates an existing activity cell treatment by its ID in Aprimo Marketing Operations. Not a true partial update -- PM validates the body against the full activity cell treatment record and rejects it ("Required property ... not found") if any required field (e.g. activityCellId, activityTreatmentId) is missing, even ones you aren't changing. Call get_activity_cell_treatment first, merge your changes into the full record, and send that. Requires confirmed=true after showing the user the exact changes. Returns the updated activity cell treatment.

Parameters:

ParameterTypeRequiredDescription
activityCellTreatmentIdstringYesThe activity cell treatment's ID.
bodystringYesJSON object with the full activity cell treatment record (PM wire names), not just the changed fields -- see the tool description.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
idinteger
activityCellTreatmentIdinteger (optional)PM's own id field for this resource (activityCellTreatmentId) -- is set from this after deserialization.
activityCellIdinteger (optional)The parent activity cell (ActivityCellTools) this cell treatment belongs to.
channelIdinteger (optional)
activityTreatmentIdinteger (optional)The activity treatment (ActivityTreatmentTools) this cell treatment references.
activityWaveIdinteger (optional)
cellPercentagenumber (optional)
estResponseRatePercentnumber (optional)
sequenceinteger (optional)
rawobject (optional)

Define Treatments & Offers​

Can change data · 20 tools · Group ID define-treatments-offers

Needs: Segment Audiences (Activity Cells), Look Up PM Reference Data

ToolWhat it does
associate_offer_treatmentsAssociates treatment IDs to an offer, by the offer's ID, in Aprimo Marketing Operations.
create_activity_offerAdds an offer to an activity in Aprimo Marketing Operations.
create_activity_treatmentAdds a treatment to an activity in Aprimo Marketing Operations.
create_offerCreates a new offer in Aprimo Marketing Operations.
create_treatmentCreates a new treatment in Aprimo Marketing Operations.
delete_activity_offerDestructive. Permanently deletes an activity offer by its integer ID in Aprimo Marketing Operations.
delete_activity_treatmentDestructive. Permanently deletes an activity treatment by its ID in Aprimo Marketing Operations.
get_activity_offerReturns a single activity offer by its integer ID in Aprimo Marketing Operations.
get_activity_treatmentReturns a single activity treatment by its ID in Aprimo Marketing Operations.
get_offerReturns a single offer by its ID in Aprimo Marketing Operations.
get_offer_treatmentsReturns the treatment IDs associated with an offer, by the offer's ID, in Aprimo Marketing Operations.
get_treatmentReturns a single treatment by its ID in Aprimo Marketing Operations.
list_activity_offersLists the offers associated with an activity, by the activity's integer ID, in Aprimo Marketing Operations.
list_activity_treatmentsLists the treatments associated with an activity, by the activity's integer ID, in Aprimo Marketing Operations.
list_offersLists offers in Aprimo Marketing Operations, paged and unfiltered.
search_treatmentsSearches treatments in Aprimo Marketing Operations by name, paged.
update_activity_offerUpdates an existing activity offer by its integer ID in Aprimo Marketing Operations.
update_activity_treatmentUpdates an existing activity treatment by its ID in Aprimo Marketing Operations.
update_offerUpdates an existing offer by its ID in Aprimo Marketing Operations.
update_treatmentUpdates an existing treatment by its ID in Aprimo Marketing Operations.

associate_offer_treatments​

Associates treatment IDs to an offer, by the offer's ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact treatment-ids payload.

Parameters:

ParameterTypeRequiredDescription
offerIdstringYesThe offer's ID.
treatmentIdsstringYesJSON payload containing the treatment IDs (PM wire shape) -- e.g. an array of ids or an object naming them, per the user's request.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the exact treatment-ids payload.

Returns:

FieldTypeDescription
offerIdstring (optional)
succeededboolean
rawobject (optional)

create_activity_offer​

Adds an offer to an activity in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created activity offer.

Parameters:

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

Returns:

FieldTypeDescription
idinteger
activityOfferIdinteger (optional)PM's own id field for this resource (activityOfferId) -- is set from this after deserialization.
offerIdinteger (optional)The top-level Offer (OfferTools) this activity offer references.
activityIdinteger (optional)
revenuePerOffernumber (optional)
rawobject (optional)

create_activity_treatment​

Adds a treatment to an activity in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created activity treatment.

Parameters:

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

Returns:

FieldTypeDescription
idinteger
activityTreatmentIdinteger (optional)PM's own id field for this resource (activityTreatmentId) -- is set from this after deserialization.
treatmentIdinteger (optional)The top-level Treatment (TreatmentTools) this activity treatment references.
activityIdinteger (optional)
currencyCodeinteger (optional)
rawobject (optional)

create_offer​

Creates a new offer in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created offer.

Parameters:

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

Returns:

FieldTypeDescription
idstring (optional)/// Not auto-mapped from the wire's offerId (see the class remarks) -- populated by PmRefDataMapper.MapOffer via a tolerant string/int read after strict deserialization of every other field.
titlestring (optional)PM's real wire field for this is title, not name -- see the class remarks.
offerCodestring (optional)
typeIdinteger (optional)
statusIdinteger (optional)
descriptionstring (optional)
ownerIdinteger (optional)
beginDatestring (optional)
expirationDatestring (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
activitySpecificinteger (optional)
incentiveIdinteger (optional)
rawobject (optional)The complete wire object, verbatim (set by the mapper). See the class remarks.

create_treatment​

Creates a new treatment in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created treatment.

Parameters:

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

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
descriptionstring (optional)
treatmentCodestring (optional)
typeIdinteger (optional)
channelIdinteger (optional)
activeFlagboolean (optional)
activitySpecificboolean (optional)
currencyCodeinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
assignedActivityIdsarray of integer (optional)
rawobject (optional)

delete_activity_offer​

Destructive

Permanently deletes an activity offer by its integer ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact activity offer with the user.

Parameters:

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

Returns:

FieldTypeDescription
idinteger
deletedboolean
Destructive operation

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


delete_activity_treatment​

Destructive

Permanently deletes an activity treatment by its ID in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact activity treatment with the user.

Parameters:

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

Returns:

FieldTypeDescription
idstring
deletedboolean
Destructive operation

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


get_activity_offer​

Returns a single activity offer by its integer ID in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
activityOfferIdstringYesThe activity offer's integer ID.

Returns:

FieldTypeDescription
idinteger
activityOfferIdinteger (optional)PM's own id field for this resource (activityOfferId) -- is set from this after deserialization.
offerIdinteger (optional)The top-level Offer (OfferTools) this activity offer references.
activityIdinteger (optional)
revenuePerOffernumber (optional)
rawobject (optional)

get_activity_treatment​

Returns a single activity treatment by its ID in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
activityTreatmentIdstringYesThe activity treatment's ID.

Returns:

FieldTypeDescription
idinteger
activityTreatmentIdinteger (optional)PM's own id field for this resource (activityTreatmentId) -- is set from this after deserialization.
treatmentIdinteger (optional)The top-level Treatment (TreatmentTools) this activity treatment references.
activityIdinteger (optional)
currencyCodeinteger (optional)
rawobject (optional)

get_offer​

Returns a single offer by its ID in Aprimo Marketing Operations. Not its treatments (use get_offer_treatments for those). Alternatively, identify the offer by name instead of offerId. Note: resolving by name scans the full offer list.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
offerIdstringNoThe offer's ID. Provide either offerId or name, not both.
namestringNoThe offer's name (case-insensitive, exact match). Provide either offerId or name, not both. Note: resolving by name scans the full offer list.

Returns:

FieldTypeDescription
idstring (optional)/// Not auto-mapped from the wire's offerId (see the class remarks) -- populated by PmRefDataMapper.MapOffer via a tolerant string/int read after strict deserialization of every other field.
titlestring (optional)PM's real wire field for this is title, not name -- see the class remarks.
offerCodestring (optional)
typeIdinteger (optional)
statusIdinteger (optional)
descriptionstring (optional)
ownerIdinteger (optional)
beginDatestring (optional)
expirationDatestring (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
activitySpecificinteger (optional)
incentiveIdinteger (optional)
rawobject (optional)The complete wire object, verbatim (set by the mapper). See the class remarks.

get_offer_treatments​

Returns the treatment IDs associated with an offer, by the offer's ID, in Aprimo Marketing Operations. PM's schema does not stabilize this response's shape -- the raw payload is preserved verbatim.

Parameters:

ParameterTypeRequiredDescription
offerIdstringYesThe offer's ID.

Returns:

FieldTypeDescription
offerIdstring (optional)
rawobject (optional)

get_treatment​

Returns a single treatment by its ID in Aprimo Marketing Operations.

Response format: the response carries a pre-rendered markdown block intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
treatmentIdstringYesThe treatment's ID.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
descriptionstring (optional)
treatmentCodestring (optional)
typeIdinteger (optional)
channelIdinteger (optional)
activeFlagboolean (optional)
activitySpecificboolean (optional)
currencyCodeinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
assignedActivityIdsarray of integer (optional)
rawobject (optional)

list_activity_offers​

Lists the offers associated with an activity, by the activity's integer ID, in Aprimo Marketing Operations. PM does not page this endpoint -- every associated offer is returned in one call.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ActivityOfferProjectionThe items returned in this response.
items[].idinteger
items[].activityOfferIdinteger (optional)PM's own id field for this resource (activityOfferId) -- is set from this after deserialization.
items[].offerIdinteger (optional)The top-level Offer (OfferTools) this activity offer references.
items[].activityIdinteger (optional)
items[].revenuePerOffernumber (optional)
items[].rawobject (optional)

list_activity_treatments​

Lists the treatments associated with an activity, by the activity's integer ID, in Aprimo Marketing Operations. PM does not page this endpoint -- every associated treatment is returned in one call.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

ParameterTypeRequiredDescription
activityIdstringYesThe activity's integer ID.

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of ActivityTreatmentProjectionThe items returned in this response.
items[].idinteger
items[].activityTreatmentIdinteger (optional)PM's own id field for this resource (activityTreatmentId) -- is set from this after deserialization.
items[].treatmentIdinteger (optional)The top-level Treatment (TreatmentTools) this activity treatment references.
items[].activityIdinteger (optional)
items[].currencyCodeinteger (optional)
items[].rawobject (optional)

list_offers​

Lists offers in Aprimo Marketing Operations, paged and unfiltered.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

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

Returns:

FieldTypeDescription
collectionNamestring (optional)Resource-name key the wire's _embedded used (e.g. "Activity", "Project"). Informational; may be null when the response isn't HAL-shaped.
totalRecordsintegerTotal record count across all pages — from the wire's _total.
countintegerNumber of items returned in this response (i.e. Items.Count; precomputed for the llm).
offsetintegerThe offset that was used to produce this page (echoes the caller's offset, clamped to ≥0).
hasMorebooleanTrue when there are more results past this page. Tools should prompt the llm to ask the user about fetching the next page.
nextOffsetinteger (optional)Offset to pass on the next request to continue. Null when is false.
itemsarray of OfferProjectionThe items returned in this response.
items[].idstring (optional)/// Not auto-mapped from the wire's offerId (see the class remarks) -- populated by PmRefDataMapper.MapOffer via a tolerant string/int read after strict deserialization of every other field.
items[].titlestring (optional)PM's real wire field for this is title, not name -- see the class remarks.
items[].offerCodestring (optional)
items[].typeIdinteger (optional)
items[].statusIdinteger (optional)
items[].descriptionstring (optional)
items[].ownerIdinteger (optional)
items[].beginDatestring (optional)
items[].expirationDatestring (optional)
items[].modifiedUserinteger (optional)
items[].modifiedDatestring (optional)
items[].activitySpecificinteger (optional)
items[].incentiveIdinteger (optional)
items[].rawobject (optional)The complete wire object, verbatim (set by the mapper). See the class remarks.

search_treatments​

Searches treatments in Aprimo Marketing Operations by name, paged. A nameFilter is required -- PM has no match-all query for this endpoint.

Response format: the response carries pre-rendered markdown blocks intended to be displayed verbatim.

Parameters:

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

Returns:

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

update_activity_offer​

Updates an existing activity offer by its integer ID in Aprimo Marketing Operations. Not a true partial update -- PM validates the body against the full activity offer record and rejects it ("Required property ... not found") if any required field (e.g. offerId, activityId) is missing, even ones you aren't changing. Call get_activity_offer first, merge your changes into the full record, and send that. Requires confirmed=true after showing the user the exact changes. Returns the updated activity offer.

Parameters:

ParameterTypeRequiredDescription
activityOfferIdstringYesThe activity offer's integer ID.
bodystringYesJSON object with the full activity offer record (PM wire names), not just the changed fields -- see the tool description.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
idinteger
activityOfferIdinteger (optional)PM's own id field for this resource (activityOfferId) -- is set from this after deserialization.
offerIdinteger (optional)The top-level Offer (OfferTools) this activity offer references.
activityIdinteger (optional)
revenuePerOffernumber (optional)
rawobject (optional)

update_activity_treatment​

Updates an existing activity treatment by its ID in Aprimo Marketing Operations. Not a true partial update -- PM validates the body against the full activity treatment record and rejects it ("Required property ... not found") if any required field (e.g. activityTreatmentId, treatmentId, activityId, currencyCode) is missing, even ones you aren't changing. Call get_activity_treatment first, merge your changes into the full record, and send that. Requires confirmed=true after showing the user the exact changes. Returns the updated activity treatment.

Parameters:

ParameterTypeRequiredDescription
activityTreatmentIdstringYesThe activity treatment's ID.
bodystringYesJSON object with the full activity treatment record (PM wire names), not just the changed fields -- see the tool description.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
idinteger
activityTreatmentIdinteger (optional)PM's own id field for this resource (activityTreatmentId) -- is set from this after deserialization.
treatmentIdinteger (optional)The top-level Treatment (TreatmentTools) this activity treatment references.
activityIdinteger (optional)
currencyCodeinteger (optional)
rawobject (optional)

update_offer​

Updates an existing offer by its ID in Aprimo Marketing Operations. Not a true partial update -- confirmed live against the tenant: PM validates the body against the full offer record and rejects it ("Required property ... not found") if any required field (e.g. offerId, title, statusId, ownerId, beginDate, modifiedUser) is missing, even ones you aren't changing. Call get_offer first, merge your changes into the full record, and send that. Alternatively, identify the offer by name instead of offerId. Note: resolving by name scans the full offer list. Requires confirmed=true after showing the user the exact changes. Returns the updated offer.

Parameters:

ParameterTypeRequiredDescription
offerIdstringNoThe offer's ID. Provide either offerId or name, not both.
namestringNoThe offer's name (case-insensitive, exact match). Provide either offerId or name, not both. Note: resolving by name scans the full offer list.
bodystringNoJSON object with the full offer record (PM wire names), not just the changed fields -- see the tool description.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
idstring (optional)/// Not auto-mapped from the wire's offerId (see the class remarks) -- populated by PmRefDataMapper.MapOffer via a tolerant string/int read after strict deserialization of every other field.
titlestring (optional)PM's real wire field for this is title, not name -- see the class remarks.
offerCodestring (optional)
typeIdinteger (optional)
statusIdinteger (optional)
descriptionstring (optional)
ownerIdinteger (optional)
beginDatestring (optional)
expirationDatestring (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
activitySpecificinteger (optional)
incentiveIdinteger (optional)
rawobject (optional)The complete wire object, verbatim (set by the mapper). See the class remarks.

update_treatment​

Updates an existing treatment by its ID in Aprimo Marketing Operations. Not a true partial update -- confirmed live against the tenant: PM validates the body against the full treatment record and rejects it ("Required property ... not found") if any required field (e.g. treatmentId, title, activeFlag, activitySpecific, currencyCode) is missing, even ones you aren't changing. Call get_treatment first, merge your changes into the full record, and send that. Requires confirmed=true after showing the user the exact changes. Returns the updated treatment.

Parameters:

ParameterTypeRequiredDescription
treatmentIdstringYesThe treatment's ID.
bodystringYesJSON object with the full treatment record (PM wire names), not just the changed fields -- see the tool description.
confirmedbooleanNoMust be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change.

Returns:

FieldTypeDescription
idstring (optional)
namestring (optional)
descriptionstring (optional)
treatmentCodestring (optional)
typeIdinteger (optional)
channelIdinteger (optional)
activeFlagboolean (optional)
activitySpecificboolean (optional)
currencyCodeinteger (optional)
modifiedUserinteger (optional)
modifiedDatestring (optional)
assignedActivityIdsarray of integer (optional)
rawobject (optional)