Messages List v2 - Placewise API

Returns messages history (SMS, Email and Push).

Request

Path Params

channel_type

string

required

Query Params

limit

integer

optional

Cursor pagination page size

>= 1<= 100

Default:

page_info

string

optional

Cursor pagination next page cursor

member_id

integer

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

Responses

🟢200Success

application/json

Body

messages

array[object (MessageHistoryModel) {21}]

required

integer

required

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

sending_id

integer

required

type

enum<string>

required

Allowed values:

emailsmspush

content

string

required

campaign_id

integer

required

loyalty_club_id

integer

required

member_id

integer

required

service_type

enum<string>

required

Allowed values:

accounting_threshold_exceeded_notificationsalready_member_messagescampaignscampaigns_testingconversation_message_received_notificationsemail_verification_messagesgames_support_messagesgenerichelp_messageskeywords_service_messageslogin_passwordsmember_export_finished_notificationsmember_verification_messagesmembers_export_finished_notificationsmembers_import_finished_notificationsmsisdn_verification_messagesnow_trendingoptinsoptoutsprogram_registration_messagesregistration_passwordsreset_password_messagesrewards_notificationssending_delivery_failing_notificationssending_delivery_lagging_notificationssending_error_notificationssending_reminder_notificationssending_sent_notificationstbp_direct_member_messagestc_article_published_user_notificationstc_document_still_not_confirmed_user_notificationstc_document_with_confirmation_created_user_notificationstc_document_without_confirmation_created_user_notificationstc_issue_created_user_notificationstc_issue_details_updated_user_notificationstc_issue_status_changed_user_notificationstc_offers_added_user_notificationstc_public_document_created_user_notificationstc_report_time_exceeded_user_notificationstc_report_time_soon_exceeded_user_notificationstc_resource_accepted_user_notificationstc_resource_added_user_notificationstc_resource_rejected_user_notificationstc_resource_still_rejected_user_notificationstc_resource_updated_user_notificationstem_abm_links_notificationstenantstenants_testingtriggersunsub_messageswelcome_messages

transmission_status

enum<string>

required

Allowed values:

newtransmittedtransiently_failedfailed

delivered

boolean

required

gateway

string

required

transmitted_at

string <date-time>

required

Example:

2022-11-09T16:25:58.099512Z

subject

string

required

Only when type is PUSH or EMAIL

from_name

string

required

Only when type is EMAIL

from_address

string

required

Only when type is EMAIL

url

string

required

Only when type is PUSH

image

string

required

Only when type is PUSH

sender

enum<string>

required

Only when type is SMS

Allowed values:

alphanumericshortcodelongcode

data

object

required

Only when type is PUSH

tags

object

required

pagination

object

required

next_page_info

string

required

Example

{
    "messages": [
        {
            "id": 0,
            "created_at": "2022-11-05T16:25:58.099512Z",
            "sending_id": 0,
            "type": "email",
            "content": "string",
            "campaign_id": 0,
            "loyalty_club_id": 0,
            "member_id": 0,
            "service_type": "accounting_threshold_exceeded_notifications",
            "transmission_status": "new",
            "delivered": true,
            "gateway": "string",
            "transmitted_at": "2022-11-09T16:25:58.099512Z",
            "subject": "string",
            "from_name": "string",
            "from_address": "string",
            "url": "string",
            "image": "string",
            "sender": "alphanumeric",
            "data": {},
            "tags": {}
        }
    ],
    "pagination": {
        "next_page_info": "string"
    }
}