POST /messaging/v1/push/definitions
Create a push send definition using existing content.
| Name | Type | Description | Attribute Requirements |
|---|---|---|---|
definitionKey | string | Required. A unique, user-generated key to access the definition object. | |
name | string | Required. The name of the definition. The value must be unique. | |
applicationId | GUID | Required. The ID of the application used to send the message. | |
content.customerKey | string | Required. The unique identifier of the content asset. | The customerKey obtained from content builder |
status | string | Operational state of the definition: activeinactivedeletedMessages sent to an active definition are processed and delivered. A message sent to an inactive definition is queued for processing for up to three days. | Transactional API - Operational Status |
description | string | The user-provided description of the send definition. | |
options.sound | string | This parameter names the sound file to play when the push message arrives on the mobile device. It overrides the value on the push message definition. The name is 100 characters or less. | |
options.badge | string | This parameter supports iOS and Android. For iOS, the value overrides the push message definition. For iOS SDK version 4.9.5 and newer, the badge on the app displays this number and raises by one for each new unread message. For older iOS SDK versions, the badge count doesn't increment. | The string value must resolve to an integer. Values such as "1", "+1", "2", and "+2" are acceptable. |
options.customKeys | array | An array of custom key/value pairs. |