offer-messages
v2

Messages

Returns merchant marketing messages that are eligible for display in the requested placement location. Results may be filtered by merchant and profile and are returned in a paginated format.

get/marketing/v2/messages

Query parameters

merchantIdstring

The Paze merchant identifier

profileIdstring

The profileId for the merchant page

messagePlacement'checkout' | 'checkoutPage' | 'checkoutMobile' | 'product' | 'productPage' | 'productMobile' | 'cart' | 'cartPage' | 'cartMobile'

The intended location for the message to be displayed.

nextTokenstring

A token for retrieving next page of results.

limitinteger

The maximum number of results to return. Max 20, default 20.

Response

OK

countinteger
limitinteger
nextTokenstring

Changes

No recorded changes to this endpoint across all 1 revision of this API.