Transactional Notifications · Sailthru Mobile Developer Documentation

## Payload Field Please refer to [Notifications Payload Field](https://docs.carnival.io/docs/notifications#section-payload-field) section. ## To Field There are three possible fields that can be used as targets: - `device_id` (Unique identification of a device) - `user_id` - `sid` (Sailthru Profile ID) ## Extra Filters In addition to targetting your push to devices by device ID, User ID or Sailthru Profile ID you can specify an `extra_filters` array which limits the devices to those which match. These filters work much the same as the [notifications API filters](https://docs.mobile.sailthru.com/docs/notifications#section-filters) except in a more limited manner. A filter is an object composed of three attributes: `name`, `criteria` and `not_filter`. [block:parameters] { "data": { "h-0": "Filter attribute", "h-1": "Details", "0-0": "`name`", "0-1": "String. Device attribute on which the criteria will be applied.\n\nExample: `{ \"name\": \"user_email\", criteria: [\"[email protected]\"] }` will match devices with a user email set to the supplied value. See the list of valid names/attributes below.", "1-0": "`criteria`", "2-0": "`not_filter`", "1-1": "Array with values to match.\n\nProvide at least one element of type string, integer, float or boolean.", "2-1": "Boolean. When `true`, it will match devices that don't match the criteria. Default is `false`." }, "cols": 2, "rows": 3 } [/block] #### Valid names/attributes for a filter [block:parameters] { "data": { "h-0": "Name/Attribute", "h-1": "Description", "0-0": "`device_id`", "0-1": "Carnival generated Device ID", "1-0": "`sid`", "1-1": "Sailthru Profile ID", "2-0": "`user_id`", "2-1": "The ID assigned to the user", "3-0": "`user_email`", "3-1": "The email address of the user of a given device" }, "cols": 2, "rows": 4 } [/block] ## Group Pushes will be grouped by a group identifier. Group identifiers must have at least 3 characters and at most 64 characters. Group identifiers can't include special characters other than hyphens (`-`) Examples: - `promotion-2018-March` - `delivery` - `SALES` ## Payload The notification payload accepts: - `alert`, `title` and `subtitle` to compose the message text - `badge` which must be a non negative number - `collapse_key` which causes push notifications to merge if another push has the same key. Its length must not be greater than 64 characters. - `mutable_content`, `content_available`, `category` special keys - Any other custom key will be sent untouched as part of the payload { "to": { "field": "user_id", "value": "john_doe" }, "group" : "coupon_codes", "payload": { "alert" : "Here is your coupon code: 12AF6CZ 🤑!", "title" : "Coupon for you", "subtitle" : "Grab your code here", "collapse_key" : "coupon-message", "coupon_code" : "12AF6CZ" "badge" : 100 } } ## Response { "id" : "5acfa75174bff800012754f0", "results": { "success": 1, "uninstalled": 2, "failures": ["5acaa58fa96e5d1a6c3716a3"] } } Results will include: - Number of successful devices that the gateway considered successfully sent; - Number of devices that got detected by the gateway as uninstalled; - Device IDs that failed to receive the push. The user must retry using `to` as: ``` { "field": "device_id", "value": "5acaa58fa96e5d1a6c3716a3" } ``` For each `device_id` returned on `failures`. The results are the gateway perspective (APNs & Firebase) about the push. ## Restrictions Liquid is not yet supported for this endpoint. The follow keys should **not** be used: - `from` - `google` - `gcm`

Method	{{ tryResults.method }}
Request Headers	{{ tryResults.requestHeaders }}
URL	{{ tryResults.url }}
Request Data	{{ tryResults.data }}
Status
Response Headers	{{ tryResults.responseHeaders }}

Sailthru Mobile Developer Documentation

Getting started

Install in your app

Message Stream

Messaging your users

Before you submit your app

REST API

Advanced Techniques

postTransactional Notifications

Definition

Parameters

Body Params

Examples

Result Format

Documentation

User Information

Try It Out