Create Push Campaign
Creates a new push notification campaign
Private key to access the API.
Schema representing campaign create request data.
Name of the campaign
Optional external id assigned to the campaign. Used to ensure idempotency, to prevent same campaign from being created more than once. Max length of 256 chars
Segment of users for whom campaign is being run
SQL query to fetch the user segment
Primary key field of the user segment table. This is the same field whose values are used as the user-id in the SDK
Campaign start schedule
Campaign start schedule
Campaign start time as unix timestamp. Applicable only if type is START_AT
Campaign message details.
Campaign type
Should send notification to iOS device
Should send notification to Android device
Map of ISO 639 language code to corresponding title text in that language. Text supports personalization.
Map of ISO 639 language code to corresponding subtitle text in that language
Map of ISO 639 language code to corresponding body text in that language. Text supports personalization.
A newer message with same collapseId will replace the older message if it is yet to be delivered to the device
Time-to-live specifies how long the server cache the message for retry before it could be delivered to the mobile device
Defines the action when notification is tapped
Url associated with the action for Android device
Url associated with the action for iOS device
A flatmap for passing any additional arguments to the tap action
Url of the image to be displayed. Android only
Url of the large icon. Android only
Resource id of the small icon. Android only
Channel on which the notification is sent. Android only
Normal priority messages are delivered immediately when the device is not sleeping. FCM attempts to deliver high priority messages immediately, allowing FCM to wake a sleeping device when necessary. Android only
Array of notification action buttons
custom sound for your notification. iOS only
Rich media url. iOS only
Rich media type. iOS only
Defines the priority and presentation style of the notification based on the content's urgency and relevance. iOS only
Increment notification badge by this number. iOS only
A relevance score is a float value between 0 and 1 that developers can assign to each notification to indicate its importance relative to other notifications from the same app. The iOS system uses this score to determine the ordering of notifications within the Notification Summary. iOS only
Setting contentAvailable to true in a push notification payload indicates that the notification should be delivered to the device immediately, even if the app is in the background or not running. This allows the app to wake up in the background and perform tasks such as fetching new content or updating data without necessarily displaying a visible notification to the user. iOS only
Notification long tap actions. iOS only
type of action category
notification category name
Array of notification action buttons
Headers
Private key to access the API.
Body
Schema representing campaign create request data.
Name of the campaign
Campaign message details.
Campaign type
MOBILE_PUSH Should send notification to iOS device
Should send notification to Android device
Map of ISO 639 language code to corresponding title text in that language. Text supports personalization.
Map of ISO 639 language code to corresponding body text in that language. Text supports personalization.
Map of ISO 639 language code to corresponding subtitle text in that language
A newer message with same collapseId will replace the older message if it is yet to be delivered to the device
Time-to-live specifies how long the server cache the message for retry before it could be delivered to the mobile device
Defines the action when notification is tapped
DEFAULT, DEEP_LINKING, RICH_LANDING Url associated with the action for Android device
Url associated with the action for iOS device
A flatmap for passing any additional arguments to the tap action
Url of the image to be displayed. Android only
Url of the large icon. Android only
Resource id of the small icon. Android only
Channel on which the notification is sent. Android only
Normal priority messages are delivered immediately when the device is not sleeping. FCM attempts to deliver high priority messages immediately, allowing FCM to wake a sleeping device when necessary. Android only
NORMAL, HIGH Array of notification action buttons
Button label
Url to be opened on button tap
Action to be performed on button tap
DEEP_LINKING, RICH_LANDING, DISMISS_NOTIFICATION custom sound for your notification. iOS only
Rich media url. iOS only
Rich media type. iOS only
IMAGE, AUDIO, VIDEO Defines the priority and presentation style of the notification based on the content's urgency and relevance. iOS only
PASSIVE, ACTIVE, TIME_SENSITIVE, CRITICAL Increment notification badge by this number. iOS only
A relevance score is a float value between 0 and 1 that developers can assign to each notification to indicate its importance relative to other notifications from the same app. The iOS system uses this score to determine the ordering of notifications within the Notification Summary. iOS only
SCORE_MAX, SCORE_0_75, SCORE_0_50, SCORE_0_25, SCORE_MIN Setting contentAvailable to true in a push notification payload indicates that the notification should be delivered to the device immediately, even if the app is in the background or not running. This allows the app to wake up in the background and perform tasks such as fetching new content or updating data without necessarily displaying a visible notification to the user. iOS only
Notification long tap actions. iOS only
type of action category
PREDEFINED_CATEGORY, CUSTOM_CATEGORY notification category name
Array of notification action buttons
Action Id
Url to be opened on button tap
Action to be performed on button tap
DEEP_LINKING, RICH_LANDING, DISMISS_NOTIFICATION A flatmap for passing any additional arguments to the tap action
Use webview for opening url
Optional external id assigned to the campaign. Used to ensure idempotency, to prevent same campaign from being created more than once. Max length of 256 chars
Response
A standard response for successful campaign creation.
UUID of the created campaign