Create User Notification Request Body

Properties

dataobject✻

Data for a notification per channel.

Documentation

Properties

pushobject

Push notifications are sent to mobile devices.

Documentation

Properties

titlestring✻

The title of a push notification. This title is typically displayed in the notification center or on the lock screen.

1..128 characters

Documentation

Example

"New Message"

bodystring✻

The body of a push notification. This text is typically displayed below the title in the notification center or on the lock screen.

1..512 characters

Documentation

Example

"You have a new message in your inbox."

prioritystring

The priority level of the push notification. Influences how fast the notification is delivered to the device.

default: normal"high""normal""low"

Documentation

soundstring

The sound file name to be used for a push notification. The file must be included in the app bundle, please refer to the platform documentation for more details.

1..128 characters

Documentation

Example

"notification.mp3"

webobject✻

Web notifications are displayed in the browser.

Documentation

Properties

messagestring✻

The notification message to be sent via web notification.

<= 256 characters

Documentation

metadataobject

The metadata for a notification.

default: [object Object]<= 16 properties

Documentation

Additional Properties

One

Metadata Boolean

Metadata Number

Metadata String

typestring✻

Type of the notification. Will be sent as a channel ID on Android devices.

1..256 characters

Documentation

Example

"cgm.high"