Messages List

Returns messages (SMS, Email and Push) sent within Loyalty Club.

Query Parameters

Parameter	Type	Required?	Default	Description
per_page	integer	no	100	Number of results to be returned per request (100 is the maximum)
page_no	integer	no	1	Number of results page
type	String[]	no	null	Message types that should be returned - available values: `["sms", "email", "push"]`
member_id	integer	no	null	When present, ony messages sent to this member will be returned

Message model

Key	Message type	Description	Required?	Type
id	all	Message ID	yes	String
type	all		yes	Enum: `["sms", "email", "push"]`
created_at	all	Time when the message has been sent	yes	ISO 8601 DateTime
content	all	Message content. Note: HTML is stripped from Email messages.	yes	String
subject	email, push	Email & push subject/title	no	String
sender	sms	SMS sender (may be string or MSISDN)	no	String
msisdn	sms	MSISDN the message has been sent to	no	String
from_name	email	Email sender name	no	String
from_address	email	Email sender address	no	String
email	email	Address the message has been sent to	no	String
url	push	A link contained by the Push message	no	String
image	push	An image contained by the Push message	no	String
data	push	Additional data contained by the Push message	no	Object
app_token	push	App token the message has been sent to	no	String
message_id	all	ID of Message in MPC Gateways	yes	Integer
sending_id	all	ID of MPC Sending	no	String
campaign_id	all	ID of MPC Sending Campaign	no	String
loyalty_club_id	all		yes	Integer
customer_id	all		yes	Integer
member_id	all		no	Integer
transmitted_at	all	Time when the message has been sent to 3rd party gateway	no	ISO 8601 DateTime
service_type	all	Service	no	String
transmission_status	all		yes	String
delivery_status	all		yes	String
tags	all	List of merge-tags supplied for the Message	no	Object[]
external_id	all	ID of Message in 3rd party system	no	String
external_error	all		no	Object
gateway	all	3rd party name (e.g. `ses`, `firebase`)	no	Object

Example

When successful, returns object containing messages sent to member and PaginationInfo

{
  "messages": [
    {
      "id": "ZW1haWw6NjY5MzM=",
      "created_at": "2022-03-04T09:15:52.062Z",
      "type": "email",
      "content": "[Logo]\n\nHi Piotr!\n\n[Placewise](https://shortener.dev.boostcom.no/y8n/ZQGeE2)",
      "subject": "Hello Piotr",
      "from_name": "MPC",
      "from_address": "dev@mpc.placewise.com",
      "email": "member@placewise.com",
      "message_id": 7038,
      "sending_id": "5350",
      "campaign_id": 421,
      "loyalty_club_id": 1174,
      "member_id": 48076883,
      "transmitted_at": "2022-03-04T09:15:53.474Z",
      "service_type": "campaigns",
      "transmission_status": "transmitted",
      "delivery_status": "sent",
      "tags": [
        { "tag": "link", "link": "https://www.placewise.com", "value": "https://shortener.dev.boostcom.no/y8n/ZQGeE2" },
        { "tag": "first_name", "value": "Piotr" }
      ],
      "external_error": { "code": 52 },
      "external_id": "e36ca3fe9778c25ea70b078978bd6087",
      "gateway": "ses"
    }
  ],
  "pagination_info": {} // Pagination info - see 'Pagination info"
}

Request

Query Params

member_id

string

optional

type

string

optional

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Query Parameters#

Message model#

Example#

Request

Request samples

Responses

Query Parameters

Message model

Example