Messages · Sailthru Mobile Developer Documentation

[block:callout] { "type": "warning", "title": "Retention policy", "body": "Rich Messages created through the API have a retention policy of 3 months. Messages in a user's stream will be deleted after this time." } [/block] ## To Field There are three options for sending * `"*"` will send to everyone * A key audience with the value set as the audience ID, retrieved via [Audiences](doc:audiences), will send to the specified audience. [block:code] { "codes": [ { "code": "{\"to\":{\"audience\":\"AUDIENCE_KEY\"} ,\"title\":\"test\",\"type\":\"text_message\",\"text\":\"test message\"}", "language": "json" } ] } [/block] * An array of filters for creating an "on-the-fly" audience will send to users who match the filters. See the [Filters](https://docs.mobile.sailthru.com/v1.4/docs/messages#section-filters) section for available filters. ## Filters 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": "Device attribute on which the criteria will be applied.\n\nExample: `{ \"name\": \"locale\", \"criteria\": [\"en-us\"] }` will match devices with en_US locale. See the list of valid [names/attributes](https://docs.mobile.sailthru.com/v1.4/docs/messages#section-valid-names-attributes-for-a-filter) below.", "1-0": "**criteria**", "1-1": "Values to match in filtering.\n\nA criteria should always be an array with at least one element of type string, integer, float, or a range object (see below [how to define a range object](https://docs.mobile.sailthru.com/v1.4/docs/messages#section-specifying-criteria-ranges)).", "2-0": "**not_filter**", "2-1": "Boolean value (false by default). When true, it will match devices that *don't* match the criteria." }, "cols": 2, "rows": 3 } [/block] ### Valid names/attributes for a filter [block:parameters] { "data": { "h-0": "Name/Attribute", "h-1": "Description", "0-0": "**locale**", "1-0": "**time_zone**", "2-0": "**created_at**", "3-0": "**registered_at**", "4-0": "**badge**", "5-0": "**os_name**", "6-0": "**os_version**", "7-0": "**app_version**", "8-0": "**sdk_version**", "9-0": "**tags**", "10-0": "**device_id**", "11-0": "**country**", "0-1": "Language used on the device. Possible values can be found [here](http://www.science.co.il/Language/Locale-codes.asp).", "1-1": "Time zone used on the device. Possible values can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", "2-1": "The date of device registration", "3-1": "The date of last device update", "4-1": "The current badge count", "5-1": "The device OS name", "6-1": "The device OS version", "7-1": "The app version on the device", "8-1": "The Sailthru SDK version", "9-1": "The tags on the device", "10-1": "The device ID assigned by Sailthru", "11-1": "The country based on user location (can be inaccurate, since sometimes the user doesn't enable GPS tracking and this value be defined using the user IP).", "12-0": "**marketing_name**", "12-1": "The device model.\n\nExamples: `iPhone 5`, `iPhone 6`, `Samsung Galaxy S5`", "13-0": "**user_id**", "13-1": "The user id on the device (Array of strings)" }, "cols": 2, "rows": 14 } [/block] ### Filtering by custom attributes The filter name should be composed as follows: `custom.` + `type of attribute (string, integer, float, date or boolean).` + `attribute_name` Examples: * `custom.string.favorite_color` * `custom.date.last_purchased` * `custom.boolean.completed_setup` ### Filtering by custom events The filter name should be composed as follows: `events.` + event name. Examples: * `events.shared_post_on_twitter` * `events.video_plays` #### Specifying criteria ranges A range is an object with at least of the following keys: `gt`, `lt`, `gte` and `lte`. [block:parameters] { "data": { "h-0": "Range key", "h-1": "Description", "0-0": "**gt**", "1-0": "**lt**", "2-0": "**gte**", "3-0": "**lte**", "0-1": "Greater than value", "1-1": "Less than value", "2-1": "Greater than or equal to value", "3-1": "Less than or equal to value" }, "cols": 2, "rows": 4 } [/block] Examples of valid ranges: * `{ "gt": 0 }` - return values greater than 0 * `{ "gt": 0, "lt": 10 }` - return values greater than zero and less than 10 (non-inclusive) * `{ "gte": 0 }` - return values greater than or equal to 0 **Note: Make sure to use the same type of double quotation marks (e.g. both smart or both straight) when testing using the message box below. ** ## unpublish_at field Optional field. When passed, the message will be unpublished from the device's message stream once the specified time has passed. The unpublish_at field's date must be specified using a UTC time with the following format: 'YYYY-MM-DDTHH:mm:SSZ'. Example: "2019-09-01T00:00:00Z".

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

postMessages

Definition

Parameters

Body Params

Examples

Result Format

Documentation

User Information

Try It Out