POST /push/v1/message
Creates a push message template for sending to a list of subscribers or an audience inclusion list or data extension. You can personalize each message for each subscriber using personalization strings or AMPscript lookups from a data extension within a single push message definition. You can also pass the text of the message to override the message contents specified in the definition for API-driven personalization.
| Name | Type | Description | |
|---|---|---|---|
| messageType | integer | Required | Indicates the type of message to create using the following integer values: 1 - Outbound (default), 3 - Location Entry, 4 - Location Exit, 5 - Beacon, 8 - Inbox |
| contentType | integer | Required | Indicates the type of content included in the message. For possible values, see Appendix: Possible Values for contentType. |
| name | string | Required | Name of the message. Must be 100 or fewer characters. For Content Builder messages, use this format: content name-unique identifier. For example: 'my test content message-0debaa7a11e11b0a00b12345ef384b1z'. |
| application | array | Required | App used to send message |
| application.id | string | Required | The ID of the application |
| application.name | string | Required | The name of the application |
| alert | string | Message displayed on the mobile device | |
| sound | string | Used to override the value on the push message definition. Indicates the sound file to play when the push message arrives on the mobile device. Name must include 100 or less characters. | |
| badge | integer | Available for iOS. For iOS SDK version 4.9.5 and newer: Overrides the value on the push message definition. Badge count displays this number in a badge on the app and increments this number by one for each new unread message. For older iOS SDK versions: Overrides the value on the push message definition. Badge count does not increment. | |
| content-available | integer | Integer value indicating the availability of content for an application enabled to use background push. Set this value to 1 to deliver the message as a silent push. This parameter applies only to apps integrated with the background push functionality available in iOS and Android. Note that you can use background push functionality in all apps with iOS 7 and Newsstand apps in iOS 6. | |
| openDirect | string | Used to override the value on the push message definition. This value determines the location within the app that an app user views when they open that app via a push message. Assigned values must include 15 or less characters. | |
| keys | array | Used to override the value on the push message definition. An array of Key/Value pairs that correspond to customer values defined in MobilePush. | |
| custom | array | Specify the actual request body of the push message to precisely align that request body to your specifications. | |
| sendInitiator | integer | Indicates the method used to initiate the send for a push message using the following integer values: 0 - UI-based send, 1 - API (default), 2 - Automation, 3 - Journey Builder | |
| startDate | date | Date and time when the message becomes available for sends. Uses a default value of the message creation time. | |
| endDate | date | Date and time when the message is no longer available for sends. This optional parameter applies only to messages whose contentType is CloudPage or Alert+CloudPage OR when the IsPushCopyToInbox flag is true. For push copy to inbox messages, this is used as the endDate for the copied Inbox Message. endDate must be after startDate. | |
| messagesPerPeriod | integer | Integer value indicating the number of messages that can send during a specified time period to throttle the volume of users responding to the notification. Use only when sendInitiator value equals 0. | |
| minutesPerPeriod | integer | Integer value indicating the number of minutes included in a specified time period. Use only when sendInitiator value equals 0. | |
| numberOfPeriods | integer | Indicates the time span of the period using the following integer values: 1 - Year, 2 - Month, 3 - Week, 4 - Day, 5 - Hour | |
| isRollingPeriod | boolean | Boolean value indicating whether the limit resets after a rolling time period window or ends at a specified time | |
| messageLimit | integer | Integer values indicating the total number of times a messages displays on a mobile device | |
| title | string | The title to be used in place of the message's original title. | |
| subtitle | string | The subtitle to be used in place of the message's original subtitle. This setting applies only to push notification alerts. | |
| mutable-content | boolean | If true, rich push functionality is enabled for the message. | |
| tzBased | boolean | Boolean value indicating whether a send occurs based on the specified time zone for a mobile device, as reflected in the contact record. To ensure timely delivery for each timezone, make sure that any dependent data extensions and audiences are available to be refreshed up to 14 hours prior to the scheduled send time. Uses a default value of false. Use only when sendInitiator value equals 0. | |
| tzPastSendAction | string | Indicates the action to perform when a time-zone-based send occurs and that send time already passed for some time zones. Uses the following string values: 1 - Send immediately (default), 2 - Send at scheduled time, next day, 3 - Never send | |
| scheduleTzOffset | integer | Integer value indicating the time zone offset. Uses a default value of -6. | |
| scheduledTzSupportsDst | boolean | Boolean value indicating whether the scheduled time zone supports Daylight Savings Time. Uses a default value of false. | |
| inclusionLists | array | Array of list ID values indicating the lists that will receive the send. Use only when sendInitiator value equals 0. | |
| exclusionLists | array | Array of list ID values indicating the lists excluded from receiving the send. Use only when sendInitiator value equals 0. | |
| status | integer | Indicates the status of the message using the following integer values:: 1 - Draft, 2 - Active (default), 3 - Inactive, 4 - Deleted | |
| pageId | integer | Integer values indicating the page associated with the message for CloudPage and Alert+CloudPage sends | |
| url | string | String value indicating the URL associated with the message. For contentType 2 and 3, this can be a CloudPage url. For contentType 4 and 5, this can be a nonCloudPage url. | |
| subject | string | String value indicating the subject line used for the message | |
| media | array | Rich media to include in the message | |
| media.androidUrl | string | URL for the media to send to Android devices | |
| media.iosUrl | string | URL for the media to send to iOS devices | |
| media.alt | string | Text to display if the message can’t include the specified rich media | |
| geofences | array | Array of string values indicating the geofences associated with the message send. Use only when sendInitiator value equals 1. | |
| InboxSubtitle | string | String value to be used as subtitle for an Inbox message. This field applies only to Inbox 2.0 messages. | |
| InboxMessage | string | String value to be used as message for an Inbox message. This field applies only to Inbox 2.0 messages. | |
| AdvanceInboxSendType | integer | Integer value indicating Push Job behaviour for old vs new (9.0 or higher) SDK versions for Inbox 2.0 messages. 0 - None [Inbox 1.0 messages], 1 - send same to old and new SDK, 2 - send to new SDK only, 3 - send different to old and new SDK. | |
| InboxFallbackSubject | string | String value to be used as subject for inbox messages on old (v8.0 and older) SDK versions. This field applies only when AdvanceInboxSendType = 3 for Inbox 2.0 messages. | |
| InboxFallbackPageUrl | string | String value to be used as URL for inbox messages on old (v8.0 and older) SDK versions. For contentType 2, this will be the cloudPage url and for contentType 4, this will be a nonCloudPage Url. This field applies only when AdvanceInboxSendType = 3 for Inbox 2.0 messages. | |
| InboxFallbackPageID | integer | Integer values to be used as page associated with the inbox message for CloudPage on old (v8.0 and older) SDK versions. This field applies only when AdvanceInboxSendType = 3 for Inbox 2.0 messages. | |
| IsPushCopyToInbox | boolean | Boolean value to be used when a Push message is to be copied and sent as an inbox message. This field applies only to push notification alerts. | |
| PushCopyToInboxScheduledTzName | string | String value indicating the time zone name used for the inbox message for push copy to inbox message. This field applies only when IsPushCopyToInbox is true. | |
| PushCopyToInboxScheduledTzOffset | integer | Integer value indicating the end Date time zone offset used for the inbox message for push copy to inbox message. This field applies only when IsPushCopyToInbox is true. |
You can create different types of messages using this call. Ensure that you include the correct properties for each message type using the list below.
API Rate Limits: We might enforce a rate limit if you perform more than 100 requests per minute or have more than 1,000 active push message templates. Rather than create a unique push message template for each subscriber, use personalization strings, AMPscript, or message field overrides when sending a push message.
- messageType
- contentType
- name (required)
- application (required)
- alert
- sound
- badge
- content-available
- openDirect
- keys
- custom
- sendInitiator
- startDate (required)
- messagesPerPeriod
- minutesPerPeriod
- tzBased
- tzPastSendAction
- scheduledTzOffset
- scheduledTzSupportsDst
- inclusionLists
- exclusionLists
- inclusionDataExtensions
- exclusionDataExtensions
- status
- media
- title
- subtitle
- messageType
- contentType
- name (required)
- application (required)
- alert (required)
- sound
- badge
- openDirect
- keys
- custom
- sendInitiator
- startDate (required)
- messagesPerPeriod
- numberOfPeriods
- periodType
- isRollingPeriod
- messageLimit
- scheduledTzOffset
- scheduledTzSupportsDst
- geofences (required)
- status
- media
- title
- subtitle
- messageType
- contentType
- name (required)
- application (required)
- alert (required)
- sound
- badge
- keys
- custom
- sendInitiator
- startDate (required)
- messagesPerPeriod
- numberOfPeriods
- periodType
- isRollingPeriod
- messageLimit
- scheduledTzOffset
- scheduledTzSupportsDst
- geofences (required)
- status
- pageId (required)
- url (required)
- media
- title
- subtitle
- messageType
- contentType
- name (required)
- application (required)
- keys
- custom
- sendInitiator
- startDate (required)
- tzBased
- tzPastSendAction
- scheduledTzOffset
- scheduledTzSupportsDst
- inclusionLists
- exclusionLists
- inclusionDataExtensions
- exclusionDataExtensions
- status
- pageId (required)
- url (required)
- subject (required)
- messageType
- contentType
- name (required)
- application (required)
- alert (required)
- sound
- badge
- content-available
- openDirect
- keys
- custom
- sendInitiator
- startDate (required)
- messagesPerPeriod
- minutesPerPeriod
- tzBased
- tzPastSendAction
- scheduledTzOffset
- scheduledTzSupportsDst
- inclusionLists
- exclusionLists
- inclusionDataExtensions
- exclusionDataExtensions
- status
- pageId (required)
- url (required)
- subject (required)
- media
- title
- subtitle
Example Request
Example Response
If all values in the request are valid, the API returns a response with the message parameters.
If the request was not valid, the API returns a 400 response with details on the error. The example below includes the error for not including any DeviceTokens values:
Possible Errors
| Message | Details |
|---|---|
| Message id {0} is not valid. | The messageID value provided in the URL was not in a valid format. |
| Message {0} is not valid for the client. | The messageID value included in the URL does not match a valid value within the account. |
| The status for Message {0} is not set to Active. | The status for the message used in the call must be set to Active. |
| The count of DeviceTokens cannot be zero. | At least one value needs to be passed in the DeviceTokens parameter. |
| One or more DeviceTokens must be specified in order to send a message. | The call does not include a parameter for the DeviceToken value. |
| Message is blank and no override message was provided. | The message definition within the MobilePush interface does not have a message specified so the messageText parameter is required. |
| Cannot override message text with a blank message. | The parameter for Override was set to true, but the value passed for messageText does not contain a value. |
| MessageText is not applicable when Override is false. | The call does not require passing a value for messageText if Override is set to true. |
| {0} is not a valid send time (yyyy-MM-dd HH | The call includes an invalid send time. |
messageType | contentType Value | Description |
|---|---|---|
| 1, 3, 4, 5 | 1 | Alert (default) |
| 1, 3, 4, 5 | 3 | Alert + CloudPage |
| 8 | 0 | Inbox only (CTA = None) |
| 8 | 1 | Inbox + Alert (CTA = None) |
| 8 | 2 | Inbox only (CTA = CloudPage) |
| 8 | 3 | Inbox + Alert (CTA = CloudPage) |
| 8 | 4 | Inbox only (CTA = App/Web URL) |
| 8 | 5 | Inbox + Alert (CTA = App/Web URL) |
For messageType 8, contentType 0, 1, 4, and 5 apply only to Inbox 2.0. The contentType 2 and 3 for messageType 8 apply to both Inbox 1.0 and Inbox 2.0.