Messages

Retrieves a list of merchant marketing messages that are eligible for display in the requested placement location. Each message includes unique identifiers, start and end timestamps, and content in both HTML and JSON. Merchant asserts identity using the access token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length between 0 and 100
^[a-zA-Z0-9_-]*$

The Paze merchant identifier

string
length between 0 and 50
^[a-zA-Z0-9_-]*$

Filters the message by profile Id.

string
enum

Filters by message placement.

string
length between 0 and 1024
^[A-Za-z0-9_-]+={0,2}$

Cursor token for retrieving the next set of messages. If including this query parameter, the other query parameters should match those of the previous request.

integer
≤ 20
Defaults to 20

Limit for the number of records returned. Max is 20

string
Defaults to true

Searches for active or inactive messages

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json