List Messages

Pending

GET

https://api.mpc.dev.placewise.com/v1/messages/{service}

API Permit:Messages:Api:Messages:Get

API Context:Loyalty Club

Authorizations:UserToken

Returns list of Messages.

URL Parameters

Key	Type	Description
service	string	Service

Query Parameters

Parameter	Type	Default	Description
per_page	integer	100	Number of results to be returned per request (100 is the maximum)
page_no	integer	1	Number of results page
sendings_status	enum	null	When present, returns only Messages having given Aggregated Sendings status
campaign_id	integer	null	When present, returns only Messages having given campaign_id
sort_by	string	array	created_at
sort_direction	string	array	asc
null_position	string	array	null
archived	boolean	null	active/archived messages
search	string	null	Returns messages containing search string in body or subject

Example

When successful, returns object containing messages and PaginationInfo

{
  "messages": [], // List of messages - see 'Message model'
  "pagination_info": {} // Pagination info - see 'Pagination info'
}

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/messages/' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

Example

{}

Modified at 2024-05-07 15:49:13

Create Message

Show Message

List Messages

URL Parameters#

Query Parameters#

Example#

Request

Request Code Samples

Responses

URL Parameters

Query Parameters

Example