Show Settings

Pending

GET

https://api.mpc.dev.placewise.com/v1/messages/settings

API Permit:Messages:Api:Settings:Show

API Context:Loyalty Club

Authorizations:UserToken

Returns Loyalty Club settings related to Message sending.

Response Body

Key	Type	Description
`settings.channels`	Object	Contains information about channels. When given channel is not available for LC, it's `null`.
`settings.channels.sms.sender_type`	string	See Channel-specific attributes
`settings.channels.sms.sender_value`	string	See Channel-specific attributes
`settings.channels.email.from_name`	string	See Channel-specific attributes
`settings.channels.email.from_email`	string	See Channel-specific attributes
`settings.channels.push.android_app_id`	string	ID of android app configured for push messages receiving
`settings.channels.push.ios_app_id`	string	ID of ios app configured for push messages receiving

Example

When successful, returns object containing settings

{
  "settings": {
    "channels": {
      "sms": {
        "sender_type": "alphanumeric",
        "sender_value": "Infinity"
      },
      "email": {
        "from_name": "Infinity",
        "from_email": "infinity-mall@placewise.com"
      },
      "push": {
        "android_app_id": "no.bstcm.loyaltyapp.infinity_mall",
        "ios_app_id": "1231452117"
      }
    }
  }
}

Request

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/settings' \
--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

Messages List

List Merge Properties

Show Settings

Response Body#

Example#

Request

Request Code Samples

Responses

Response Body

Example