Sign in

v1

latestOpenAPI 3.0.12026-07-24116117186.3 KB
Messages

Add base Mobile Push message

The method is used for creating new Mobile Push message.

post/api/v1/messages/mobilepush

Request body

idinteger

Message ID.

namestring required

Message name.

languageCodestring

Language code.

tagsstring[]

List of tags.

subscriptionsKeysstring[]

Subscription categories keys, assigned to a message.

languagesstring[]

An array with the language codes for multilingual messages. Available for the GET method only.

titlestring required

Message title.

subtitlestring

Message subtitle. Visible only to iOS users.

textstring required

Message text.

linkstring

Can be either an external link (opens in device browser) or a deep link (opens some section of the app).

imageSourcestring

Image URL for a single image in a message. Use 'images' array to create an images carousel.

customDatastring

Additional parameters in JSON format to be used in the push message.

ttlSecinteger

Time-to-live for a message; in seconds.

soundEnabledboolean

Enable to play sound when user receives push-message.

badgeCountinteger

The number of unread messages shown to the user.

imagesstring[]

The array of image URLs for images carousel. Up to 10 images.

Example request

{
  "title": "Your order is confirmed",
  "subtitle": "Order number 002345",
  "text": "You order 002345 is confirmed",
  "link": "https://www.yourshop.com/account/order",
  "imageSource": "https://www.example.com/images/sample.jpg",
  "ttlSec": 3600,
  "badgeCount": 50,
  "translations": [
    {
      "title": "Your order is confirmed",
      "subtitle": "Order number 002345",
      "text": "You order 002345 is confirmed",
      "link": "https://www.yourshop.com/account/order",
      "imageSource": "https://www.example.com/images/sample.jpg",
      "ttlSec": 3600,
      "badgeCount": 50
    }
  ]
}