Sign in

v1

latestOpenAPI 3.0.12026-07-24116117186.3 KB
Messages

Update the base App Inbox message

The method is used for updating the base App Inbox message.

put/api/v1/messages/appinbox/{id}

Path parameters

idinteger required

App inbox message ID

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.

textstring required

Message text.

linkstring

The link that will open after the click on the message body.

imageSourcestring

The logo image in JPEG, PNG or GIF format.

customDatastring

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

ttlSecinteger

Time-to-live for the message, in seconds.

Example request

{
  "title": "Account created",
  "text": "Thank you for signing up!",
  "link": "https://www.example.com",
  "ttlSec": 3600,
  "translations": [
    {
      "title": "Account created",
      "text": "Thank you for signing up!",
      "link": "https://www.example.com",
      "ttlSec": 3600
    }
  ]
}