# Push Core schemas for push notifications, including push objects, notification payloads, Message Center messages, in-app messages, and related response objects. ## Actions {#actionsobject} Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). [Jump to examples ↓](#actionsobject-examples) - **`add_custom_event`** `object` Emit a custom event when a user interacts with the push notification. **OBJECT PROPERTIES** - **`name`** `string` **REQUIRED** The name of the custom event. - **`properties`** `object` A JSON object with the properties associated with the event. - **`value`** `number` An integer or decimal value of the event. - **`add_tag`** `array[string]` An array of tags. Min items: 0, Max items: 100 Example: `Federer fan,Messi fan` - **`app_defined`** `object` A map of registered action names to payloads as defined by the app or SDK. Some of these actions are supported as their own property on the Actions object, but be aware that their registered names in the SDK may be different. For a summary of the actions registered by the SDK, including usage information, see the [SDK Actions](/docs/sdk-topics/actions/) docs. - **`open`** `object` Open action. When a user interacts with the notification, opens one of: URL, deep link, or landing page as described in the associated `content` property. **One of:** - **Open URL Action** `object` Opens a URL or passes a string for use as a custom action. - **`content`** `string` **REQUIRED** Any string. A URL string that starts with either `http` or `https` will open a URL or a string that starts with `tel:` followed by a sequence of numbers will open the phone app. Example: `https://www.airship.com/docs,tel:15035551234` - **`type`** `string` **REQUIRED** Possible values: `url` - **Open Deep Link Action** `object` Opens a deep link. - **`content`** `string` **REQUIRED** A non-blank string. Min length: 1, Max length: 1024 - **`fallback_url`** `string` A URL that can be used on platforms that don't have full support for the otherwise defined action. Format: `url` Example: `https://www.airship.com/docs` - **`type`** `string` **REQUIRED** Possible values: `deep_link` - **Open Landing Page** `object` Opens a landing page. - **`content`** `object` <[Landing page content]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#landingpagecontent)> **REQUIRED** - **`type`** `string` **REQUIRED** Possible values: `landing_page` - **`remove_tag`** `array[string]` An array of tags. Min items: 0, Max items: 100 Example: `Federer fan,Messi fan` - **`share`** `string` String indicating the text that will populate the share action. Min length: 1, Max length: 1024 Example: `Hey guys check this out!` - **`subscription_list`** `array[object]` Alter subscription list membership for a channel or contact. **One of:** - **`action`** `string` <[Subscription List action]({{< ref "/developer/rest-api/ua/schemas/subscription-lists/" >}}#subscriptionlistmutation)> **REQUIRED** A string representing the membership mutation action to be taken for a given list. Possible values: `subscribe`, `unsubscribe` - **`list_id`** `string` <[List ID]({{< ref "/developer/rest-api/ua/schemas/subscription-lists/" >}}#subscriptionlistid)> **REQUIRED** A list ID that contains only alphanumeric characters, underscores, or hyphens. - **`type`** `string` **REQUIRED** Possible values: `channel` - **`action`** `string` <[Subscription List action]({{< ref "/developer/rest-api/ua/schemas/subscription-lists/" >}}#subscriptionlistmutation)> **REQUIRED** A string representing the membership mutation action to be taken for a given list. Possible values: `subscribe`, `unsubscribe` - **`list_id`** `string` <[List ID]({{< ref "/developer/rest-api/ua/schemas/subscription-lists/" >}}#subscriptionlistid)> **REQUIRED** A list ID that contains only alphanumeric characters, underscores, or hyphens. - **`scope`** `string` <[Scopes]({{< ref "/developer/rest-api/ua/schemas/subscription-lists/" >}}#scopes)> **REQUIRED** The channel types where membership applies. The `app` scope includes `iOS`, `Android`, and `Amazon` channels. Possible values: `app`, `web`, `email`, `sms` - **`type`** `string` **REQUIRED** Possible values: `contact` **Used in:** - [Create and Send a message]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#createandsend) - [Create experiment (A/B Test)]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#createexperiment) - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Create template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#createtemplate) - [Experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiments) - [Experiment lookup]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiment) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [List templates]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplates) - [Look up a template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplate) - [Schedule a Create and Send message]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulecreateandsendoperations) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Scheduled experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getscheduledexperiments) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Update template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#updatetemplate) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate Create and Send payload]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatecreateandsendpayload) - [Validate experiment]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#validateexperiment) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) **Examples** *Example add custom event action* ```json { "actions": { "add_custom_event": { "name": "myCustomEvent", "value": 12.5, "properties": { "property_key1": "value_property1", "property_key2": 6789 } } } } ``` *Example tag actions* ```json { "actions": { "add_tag": [ "airship", "blimp" ], "remove_tag": [ "boat", "car" ], "share": "Check out Airship!", "open": { "type": "url", "content": "http://www.urbanairship.com" }, "app_defined": { "some_app_defined_action": "some_value" } } } ``` *Example landing page action* ```json { "actions": { "open": { "type": "landing_page", "content": { "body": "content", "content_type": "text/html", "content_encoding": "utf-8" }, "fallback_url" : "https://www.urbanairship.com/settings" } } } ``` *Example open phone app* ```json { "actions": { "open": { "type": "url", "content": "tel:15035551234" } } } ``` *Example deep link action* ```json { "actions": { "open": { "type": "deep_link", "content": "prefs", "fallback_url": "https://www.urbanairship.com/settings" } } } ``` *Example Subscription List action* ```json { "actions": { "subscription_list": [ { "action": "subscribe", "type": "contact", "list_id": "cool_deals", "scope": "app" } ] } } ``` --- ## Campaigns object {#campaignsobject} An object specifying custom campaign categories related to the notification. [Jump to examples ↓](#campaignsobject-examples) - **`categories`** `array[string]` **REQUIRED** Array of strings representing the campaigns you wish to associate with the notification. Must have between 1 to 10 items in the array with a 64 character/byte maximum per item. Min items: 1, Max items: 10 Example: `shoes,running,summer 2017` **Used in:** - [Create and Send a message]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#createandsend) - [Create experiment (A/B Test)]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#createexperiment) - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Create template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#createtemplate) - [Experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiments) - [Experiment lookup]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiment) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [List templates]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplates) - [Look up a template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplate) - [Push to template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#pushtotemplate) - [Schedule a Create and Send message]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulecreateandsendoperations) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Scheduled experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getscheduledexperiments) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Update template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#updatetemplate) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate a template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#validatetemplate) - [Validate Create and Send payload]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatecreateandsendpayload) - [Validate experiment]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#validateexperiment) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) **Examples** *Example campaigns in a push payload* ```json { "audience": "all", "notification": { "alert": "Taco Kitten wins Kentucky Derby by a whisker" }, "campaigns": { "categories": [ "kittens", "tacos", "horse_racing" ] }, "device_types": [ "ios", "android" ] } ``` --- ## In-app message {#inappobject} A JSON object describing an in-app message payload. [Jump to examples ↓](#inappobject-examples) - **`actions`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`alert`** `string` **REQUIRED** The text displayed on the in-app message. - **`display`** `object` The allowed fields for this object depend on the value of of the `display_type` field. Currently, the only valid `display_type` is `banner`, so the following is an associated display object for the banner display type. **OBJECT PROPERTIES** - **`duration`** `integer` Specifies how long the notification should stay on the screen in seconds before automatically disappearing; set to `15` by default. Default: `15` - **`position`** `string` One of either `top` or `bottom`, specifies the screen position of the message. Defaults to `bottom`. Possible values: `top`, `bottom` Default: `bottom` - **`primary_color`** `string` Specifies the primary color of the in-app message (format `#rrggbb`). Example: `#FF0000` - **`secondary_color`** `string` Specifies the secondary color of the in-app message (format `#rrggbb`). Example: `#00FF00` - **`display_type`** `string` **REQUIRED** Specifies the display type. Possible values: `banner` - **`expiry`** `object` Delivery expiration, as either absolute ISO UTC timestamp, or number of seconds from now. **One of:** - `integer` Number of seconds from now. When the delivery platform supports it, a value of zero (0) indicates that the message should be delivered immediately and never stored for later attempts. - `string` A [date-time](/docs/developer/rest-api/ua/introduction/#date-time-format). - **`extra`** `object` A JSON dictionary of string-to-string key-value pairs. If you wish to pass structured data in an extra key, it must be JSON-encoded as a string. Example: `[object Object]` - **`interactive`** `object` <[Interactive notification object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#interactiveobject)> An interactive notification. Attempting to specify an interactive payload for an unsupported device type will result in an HTTP 400 response. **Used in:** - [Create experiment (A/B Test)]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#createexperiment) - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Create template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#createtemplate) - [Experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiments) - [Experiment lookup]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiment) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [List templates]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplates) - [Look up a template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplate) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Scheduled experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getscheduledexperiments) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Update template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#updatetemplate) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate experiment]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#validateexperiment) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) **Examples** *Example* ```json { "audience": "all", "device_types": [ "ios", "android" ], "notification": { "alert": "This part appears on the lockscreen" }, "in_app": { "alert": "This part appears in-app!", "display_type": "banner", "expiry": "2020-04-01T12:00:00", "display": { "position": "top" }, "actions": { "add_tag": "in-app" } } } ``` --- ## Interactive notification object {#interactiveobject} An interactive notification. Attempting to specify an interactive payload for an unsupported device type will result in an HTTP 400 response. [Jump to examples ↓](#interactiveobject-examples) - **`button_actions`** `object` An object containing keys that must be the button IDs for the specified interactive notification type. If the notification type begins with `ua_`, the keys must match exactly the button IDs for that type or a strict subset. The names of the button IDs cannot be validated for custom notifications. **One of:** - **Yes/No** `object` Yes/No button action - **`no`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`yes`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Accept/Decline** `object` Accept/decline button action - **`accept`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`decline`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Shop Now** `object` Shop now button action - **`shop_now`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Buy Now** `object` Buy now button action - **`buy_now`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Follow** `object` Follow button action - **`follow`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Opt In** `object` Opt in button action - **`opt_in`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Unfollow** `object` Unfollow button action - **`unfollow`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Opt Out** `object` Opt out button action - **`opt_out`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Opt In/Remind** `object` Opt in/remind button action - **`opt_in`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`remind`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Remind** `object` Remind button action - **`remind`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **More Info** `object` More info button action - **`more_info`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Download** `object` Download button action - **`download`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Share** `object` Share button action - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Download/Share** `object` Download/share button action - **`download`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Remind/Share** `object` Remind/share button action - **`remind`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Opt In/Share** `object` Opt in/share button action - **`opt_in`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Opt Out/Share** `object` Opt out/share button action - **`opt_out`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Follow/Share** `object` Follow/share button action - **`follow`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Unfollow/Share** `object` Unfollow/share button action - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`unfollow`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Shop Now/Share** `object` Shop now/share button action - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`shop_now`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Buy Now/Share** `object` Buy now/share button action - **`buy_now`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **More Like/Less Like** `object` More like/less like button action - **`less_like`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`more_like`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Like/Dislike** `object` Like/dislike button action - **`dislike`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`like`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Like** `object` Like button action - **`like`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Like/Share** `object` Like/share button action - **`like`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`share`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Add to Calendar/Remind** `object` Add to calendar/remind button action - **`add_calendar`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`remind`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Add** `object` Add button action - **`add`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Save** `object` Save button action - **`save`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Follow/Save** `object` Follow/Save button action - **`follow`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`save`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Rate** `object` Rate button action - **`rate`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Rate/Remind** `object` Rate/remind button action - **`rate`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`remind`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Search** `object` Search button action - **`search`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Book** `object` Book button action - **`book`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Happy/Sad** `object` Happy/Sad button action - **`happy`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`sad`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **Up/Down** `object` Up/down button action - **`down`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`up`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`type`** `string` **REQUIRED** A string that specifies the name of either a predefined or a custom-defined interactive notification type. Predefined types are prefixed with `ua_`. Possible values: `ua_yes_no_foreground`, `ua_yes_no_background`, `ua_accept_decline_foreground`, `ua_accept_decline_background`, `ua_shop_now`, `ua_buy_now`, `ua_follow`, `ua_opt_in`, `ua_unfollow`, `ua_opt_out`, `ua_opt_in_remind`, `ua_remind_me_later`, `ua_more_info`, `ua_download`, `ua_share`, `ua_download_share`, `ua_remind_share`, `ua_opt_in_share`, `ua_opt_out_share`, `ua_follow_share`, `ua_unfollow_share`, `ua_shop_now_share`, `ua_buy_now_share`, `ua_more_like_less_like`, `ua_like_dislike`, `ua_like`, `ua_like_share`, `ua_add_calendar_remind`, `ua_add`, `ua_save`, `ua_follow_save`, `ua_rate`, `ua_rate_remind`, `ua_search`, `ua_book`, `ua_icons_happy_sad`, `ua_icons_up_down`, `` Example: `ua_yes_no_foreground` **Used in:** - [Create and Send a message]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#createandsend) - [Create experiment (A/B Test)]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#createexperiment) - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Create template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#createtemplate) - [Experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiments) - [Experiment lookup]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiment) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [List templates]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplates) - [Look up a template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplate) - [Schedule a Create and Send message]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulecreateandsendoperations) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Scheduled experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getscheduledexperiments) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Update template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#updatetemplate) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate Create and Send payload]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatecreateandsendpayload) - [Validate experiment]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#validateexperiment) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) **Examples** *Example with `type` actions* ```json { "interactive": { "type": "ua_yes_no_foreground", "button_actions": { "yes": { "add_tag": "more_cake_please", "remove_tag": "lollipop", "open": { "type": "url", "content": "http://www.urbanairship.com" } }, "no": { "add_tag": "nope" } } } } ``` *Example with `ua_share` actions* ```json { "interactive": { "type": "ua_share", "button_actions": { "share": { "share": "Look at me! I'm on a boat." } } } } ``` --- ## Landing page content {#landingpagecontent} **One of:** - **`url`** `string` **REQUIRED** The URL to be opened as a landing page. This value supports `http` or `https` schemes and can be personalized using handlebars expressions. Format: `url` **All of:** - **`content_encoding`** `string` A string specifying the encoding of the text in the `body` attribute. Defaults to `utf-8`. Possible values: `utf-8`, `base64` - **`content_type`** `string` **REQUIRED** A non-blank string, which must be a MIME type. Min length: 1, Max length: 128 Example: `text/html` - `oneOf` **Used in:** - [Create and Send a message]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#createandsend) - [Create experiment (A/B Test)]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#createexperiment) - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Create template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#createtemplate) - [Experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiments) - [Experiment lookup]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiment) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [List templates]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplates) - [Look up a template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplate) - [Schedule a Create and Send message]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulecreateandsendoperations) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Scheduled experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getscheduledexperiments) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Update template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#updatetemplate) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate Create and Send payload]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatecreateandsendpayload) - [Validate experiment]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#validateexperiment) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) --- ## Localization object {#localization} An object used to indicate that message content delivered to a device should be customized for a specific locale subset. Each localization object must have at least one of country and language. Which of those two fields are present does not need to be consistent across localizations. In addition, each localization object must have one of `notification`, `message`, or `in_app` set. If the top level `notification`, `message`, or `in_app` fields are set, they will be delivered to any user in the audience not matching any of the localizations. [Jump to examples ↓](#localization-examples) - **`country`** `string` The ISO 3166-2 two-letter country code for this localization. - **`in_app`** `object` <[In-app message]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#inappobject)> A JSON object describing an in-app message payload. - **`language`** `string` The ISO 639-1 two-letter language code for this localization. - **`message`** `object` <[Message Center object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#messageobject)> A Message Center message. - **`notification`** `object` <[Notification object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#notificationobject)> The notification payload that is required unless either `message` or `in_app` is present. You can provide an `alert` and any platform overrides that apply to the `device_type` platforms you specify. **Used in:** - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) **Examples** *Example array of localizations* ```json { "localizations": [ { "language": "de", "country": "AT", "notification": { "alert": "Grüss Gott" } }, { "language": "de", "country": "DE", "notification": { "alert": "Guten Tag" } } ] } ``` --- ## Message Center object {#messageobject} A Message Center message. [Jump to examples ↓](#messageobject-examples) - **`body`** `string` **REQUIRED** The body of the message. - **`content_encoding`** `string` A string denoting encoding type of the data in body. Defaults to `utf-8`. `base64` encoding can be used in cases which would be complex to escape properly, just as HTML containing embedded javascript code, which itself may contain embedded JSON data. Default: `utf-8` Example: `utf-8` - **`content_type`** `string` A string denoting the MIME type of the data in body. Defaults to `text/html`. Example: `text/html` - **`expiry`** `object` Delivery expiration, as either absolute ISO UTC timestamp, or number of seconds from now. **One of:** - `integer` Number of seconds from now. When the delivery platform supports it, a value of zero (0) indicates that the message should be delivered immediately and never stored for later attempts. - `string` A [date-time](/docs/developer/rest-api/ua/introduction/#date-time-format). - **`extra`** `object` A JSON dictionary of string-to-string key-value pairs. If you wish to pass structured data in an extra key, it must be JSON-encoded as a string. Example: `[object Object]` - **`icons`** `object` A JSON dictionary of string key and value pairs representing icons. At this time, only the `list_icon` key is supported. Values must be URI/URLs to icon resources. For resources hosted by UA, use the following URI format `ua:`. **OBJECT PROPERTIES** - **`list_icon`** `string` Example: `ua: 9bf2f510-050e-11e3-9446-14dae95134d2` - **`title`** `string` **REQUIRED** The title of the message. **Used in:** - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) **Examples** *Message object example* ```json { "audience": "all", "notification": { "ios": { "badge": "+1" } }, "message": { "title": "This week's offer", "body": "

blah blah

etc...", "content_type": "text/html", "expiry": "2020-04-01T12:00:00", "extra": { "offer_id": "608f1f6c-8860-c617-a803-b187b491568e" }, "icons": { "list_icon": "http://cdn.example.com/message.png" } } } ``` --- ## Message Center with template {#messageobjectwithtemplate} Use a `template` with a message center message. You can reference a template by ID, or use `{{handlebars}}` directly in your message. [Jump to examples ↓](#messageobjectwithtemplate-examples) - **`content_encoding`** `string` A string denoting encoding type of the data in body. Defaults to `utf-8`. `base64` encoding can be used in cases which would be complex to escape properly, just as HTML containing embedded javascript code, which itself may contain embedded JSON data. Default: `utf-8` Example: `utf-8` - **`content_type`** `string` A string denoting the MIME type of the data in body. Defaults to `text/html`. Example: `text/html` - **`expiry`** `object` Delivery expiration, as either absolute ISO UTC timestamp, or number of seconds from now. **One of:** - `integer` Number of seconds from now. When the delivery platform supports it, a value of zero (0) indicates that the message should be delivered immediately and never stored for later attempts. - `string` A [date-time](/docs/developer/rest-api/ua/introduction/#date-time-format). - **`extra`** `object` A JSON dictionary of string-to-string key-value pairs. If you wish to pass structured data in an extra key, it must be JSON-encoded as a string. Example: `[object Object]` - **`icons`** `object` A JSON dictionary of string key and value pairs representing icons. At this time, only the `list_icon` key is supported. Values must be URI/URLs to icon resources. For resources hosted by UA, use the following URI format `ua:`. **OBJECT PROPERTIES** - **`list_icon`** `string` Example: `ua: 9bf2f510-050e-11e3-9446-14dae95134d2` - **`template`** `object` **One of:** - - **`template_id`** `string` The ID of a template created in the Airship dashboard or the API. See [Using content templates](/docs/guides/personalization/content/templates/#using-content-templates) for more information. Format: `uuid` - - **`external_id`** `string` The user-provided identifier of a template created in the Airship dashboard or the API. See [Using content templates](/docs/guides/personalization/content/templates/#using-content-templates) for more information. - - **`fields`** `object` Items in the field object are personalizable with handlebars. **OBJECT PROPERTIES** - **`html_body`** `string` The body of the message. This can be a full HTML message. - **`title`** `string` The title of the message. **Used in:** - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) **Examples** *Message Center with template using handlebars example* ```json { "message": { "title": "Save on {{product}} through {{end_date}}!", "body": "

here's a cool {{offer}}

etc...", "content_type": "text/html", "expiry": "2020-04-01T12:00:00", "extra": { "offer_id": "608f1f6c-8860-c617-a803-b187b491568e" }, "icons": { "list_icon": "http://cdn.example.com/message.png" } } } ``` *Message Center with template by ID example* ```json { "message": { "template": { "template_id": "my_template_id" } } } ``` --- ## Message type {#messagetype} Indicates the purpose of a message. `string` Allowed values: `transactional`, `commercial` **Used in:** - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) --- ## Notification object {#notificationobject} The notification payload that is required unless either `message` or `in_app` is present. You can provide an `alert` and any platform overrides that apply to the `device_type` platforms you specify. [Jump to examples ↓](#notificationobject-examples) - **`actions`** `object` <[Actions]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#actionsobject)> Describes Actions to be performed by the SDK when a user interacts with the notification. You can personalize message actions using [Handlebars](/docs/guides/personalization/handlebars/). - **`alert`** `string` A notification message, displayed for any platforms receiving the push without a platform override. - **`amazon`** `object` **One of:** - [Fire OS overrides]({{< ref "/developer/rest-api/ua/schemas/platform-overrides/" >}}#amazonoverrideobject) The platform override section for Kindle Fire (for Amazon Device Messaging). - [Fire OS overrides with template]({{< ref "/developer/rest-api/ua/schemas/platform-overrides-with-templates/" >}}#amazonoverridewithtemplate) Use a `template` with a Fire OS-specific message. You can reference a template by ID, or use `{{handlebars}}` directly in your message. - **`android`** `object` **One of:** - [Android overrides]({{< ref "/developer/rest-api/ua/schemas/platform-overrides/" >}}#androidoverrideobject) The platform override section for Android. Maximum 4,096 bytes. - [Android overrides with template]({{< ref "/developer/rest-api/ua/schemas/platform-overrides-with-templates/" >}}#androidoverridewithtemplate) Use a `template` with an Android-specific fields. You can reference a template by ID, or use `{{handlebars}}` directly in your message. - **`email`** `object` **One of:** - [Email overrides]({{< ref "/developer/rest-api/ua/schemas/platform-overrides/" >}}#emailoverrideobject) Notification fields specific to email messages. This object is required when `email` is specified in the payload's `device_types` field. - [Email notification with template]({{< ref "/developer/rest-api/ua/schemas/platform-overrides-with-templates/" >}}#emailoverridewithtemplate) Notification fields specific to email messages with an inline template for use in a [Create and Send](/docs/developer/rest-api/ua/operations/bulk-sending/#createandsend) payload. Using a template enables you to provide and populate variables in your notification. You can also add conditional statements based on those variables, determining message text that to send to each member of your audience. Conditionals begin with `{{#operator}}` and end with `{{/operator}}`. For more information, see [Handlebars](/docs/guides/personalization/handlebars/). - **`interactive`** `object` <[Interactive notification object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#interactiveobject)> An interactive notification. Attempting to specify an interactive payload for an unsupported device type will result in an HTTP 400 response. - **`ios`** `object` **One of:** - [iOS overrides]({{< ref "/developer/rest-api/ua/schemas/platform-overrides/" >}}#iosoverrideobject) The platform override section for iOS. Maximum 4,096 bytes. - [iOS overrides with template]({{< ref "/developer/rest-api/ua/schemas/platform-overrides-with-templates/" >}}#iosoverridewithtemplate) Use a `template` with iOS-specific message. You can reference a template by ID, or use `{{handlebars}}` directly in your message. - **`mms`** `object` **One of:** - [MMS platform overrides]({{< ref "/developer/rest-api/ua/schemas/platform-overrides/" >}}#mmsoverrideobject) Provides the content for a push to MMS channels. If `sms` is in the `device_type` array, your request may include this object. It cannot be combined with an SMS Platform Override as a single push can only include either an SMS or MMS payload. - [MMS notification with inline template]({{< ref "/developer/rest-api/ua/schemas/platform-overrides-with-templates/" >}}#mmsoverridewithtemplate) Template and notification overrides for a Create and Send payload with `device_types` set to `mms`. With a template, you can provide and populate variables and conditional statements based on those variables. Conditionals begin with `{{#operator}}` and end with `{{/operator}}`. For more information, see [Handlebars](/docs/guides/personalization/handlebars/). - **`open::open_platform_name`** `object` **One of:** - [Open channel override]({{< ref "/developer/rest-api/ua/schemas/platform-overrides/" >}}#openchanneloverrideobject) The platform override section for open platforms uses the prefix attribute `open::` before the configured open platform name. The `open::` object will contain an object with the following attributes. - [Open channel overrides with template]({{< ref "/developer/rest-api/ua/schemas/platform-overrides-with-templates/" >}}#openchanneloverridewithtemplate) Use a `template` with an open channel-specific message. You can reference a template by ID, or use `{{handlebars}}` directly in your message. - **`sms`** `object` **One of:** - [SMS platform overrides]({{< ref "/developer/rest-api/ua/schemas/platform-overrides/" >}}#smsoverrideobject) Provides override options when `sms` is one of the `device_types` specified in the payload. - [SMS notification with template]({{< ref "/developer/rest-api/ua/schemas/platform-overrides-with-templates/" >}}#smsoverridewithtemplate) Notification fields specific to SMS messages with an inline template for use in a [Create and Send](/docs/developer/rest-api/ua/operations/bulk-sending/#createandsend) payload. Using a template enables you to provide and populate variables in your notification. You can also add conditional statements based on those variables, determining message text that to send to each member of your audience. Conditionals begin with `{{#operator}}` and end with `{{/operator}}`. For more information, see [Handlebars](/docs/guides/personalization/handlebars/). - **`web`** `object` **One of:** - [Web overrides]({{< ref "/developer/rest-api/ua/schemas/platform-overrides/" >}}#weboverrideobject) The `web` platform overrides determine message behaviors for web notifications. Safari behaves differently from other browsers and supports only the `alert` and `title` overrides. It ignores all other `web` overrides. - [Web overrides with template]({{< ref "/developer/rest-api/ua/schemas/platform-overrides-with-templates/" >}}#weboverridewithtemplate) Use a `template` with a Web-specific message. You can reference a template by ID, or use `{{handlebars}}` directly in your message. Safari behaves differently from other browsers and supports only the `alert` and `title` overrides. It ignores all other `web` overrides. **Used in:** - [Create experiment (A/B Test)]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#createexperiment) - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Create template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#createtemplate) - [Experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiments) - [Experiment lookup]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiment) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [List templates]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplates) - [Look up a template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#gettemplate) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Scheduled experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getscheduledexperiments) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Update template]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#updatetemplate) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate experiment]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#validateexperiment) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) **Examples** *Example notification with all platforms* ```json { "audience": "all", "device_types": [ "ios", "android", "amazon", "web", "email", "open::toaster" ], "notification": { "ios": { "alert": "Hello, iDevices" }, "android": { "alert": "These are not the...yeah, lame joke." }, "amazon": { "alert": "Read any good books lately?" }, "web": { "alert": "Oh the tangled web we weave" }, "email": { "subject": "Did you get that thing I sent you?", "html_body": "

Richtext body goes here

Wow!

Unsubscribe

", "plaintext_body": "Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]", "message_type": "commercial", "sender_name": "Airship", "sender_address": "team@urbanairship.com", "reply_to": "no-reply@urbanairship.com" }, "open::toaster": { "alert": "Would you like avocados with that?" } } } ``` --- ## Push object {#pushobject} A push object describes everything about a push notification, including the audience and push payload. A push object is composed of up to seven attributes. [Jump to examples ↓](#pushobject-examples) - **`audience`** `object` <[Audience selector (max 1000)]({{< ref "/developer/rest-api/ua/schemas/audience-selection/" >}}#audienceselector1000)> **REQUIRED** An audience selector forms the expression that determines the set of channels to target. - **`campaigns`** `object` <[Campaigns object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#campaignsobject)> An object specifying custom campaign categories related to the notification. - **`device_types`** `array[string]` **REQUIRED** An array containing one or more strings identifying targeted platforms. Min items: 1 Possible values: `android`, `amazon`, `ios`, `web`, `sms`, `mms`, `email`, `open::open_platform_name` - **`feed_references`** `object` <[Feed references object]({{< ref "/developer/rest-api/ua/schemas/external-data-feeds-references/" >}}#feedreferences)> An object used to indicate that an external data feed should be invoked, the name of the feed to invoke, and the way in which to invoke it. You can only include a feed if you include a `templates` object in the payload or set the `personalization` option to `true`. - **`global_attributes`** `object` The global attributes object may contain an arbitrary set of keys and values, including arrays and nested objects, which will be added to the global attributes rendering namespace for this push. Top-level keys must start with a letter and cannot start with the reserved sequence ``ua_``. If the global attributes object is nonempty, it implies the ``personalization: true`` option. - **`in_app`** `object` <[In-app message]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#inappobject)> A JSON object describing an in-app message payload. - **`localizations`** `array` <[Localization object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#localization)> An array of localizations. Channels bearing the specified language/country combination will receive the corresponding message. - **`message`** `object` **One of:** - [Message Center object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#messageobject) A Message Center message. - [Message Center with template]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#messageobjectwithtemplate) Use a `template` with a message center message. You can reference a template by ID, or use `{{handlebars}}` directly in your message. - **`message_type`** `string` <[Message type]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#messagetype)> Indicates the purpose of a message. Possible values: `transactional`, `commercial` - **`notification`** `object` <[Notification object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#notificationobject)> The notification payload that is required unless either `message` or `in_app` is present. You can provide an `alert` and any platform overrides that apply to the `device_type` platforms you specify. - **`options`** `object` <[Push options]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#pushoptions)> A JSON dictionary for specifying non-payload options related to the delivery of the push. - **`orchestration`** `object` An object used to indicate the strategy to employ when deciding which channels to target for a contact. An orchestration object can be stored in Airship as the default strategy. If the orchestration section is included in a push payload, it will override the configured default value. The overall default strategy is `fan_out`. **OBJECT PROPERTIES** - **`channel_priority`** `array[string]` An array of channel types in priority order. Required if `type` is set to `channel_priority`. - **`type`** `string` **REQUIRED** The name of the orchestration strategy to employ. Possible values: `channel_priority`, `fan_out`, `triggering_channel`, `last_active` - **`snippet_references`** `object` <[Snippet references object]({{< ref "/developer/rest-api/ua/schemas/push/" >}}#snippetreferences)> An object used to indicate that a set of snippets should be loaded for use in message content. Use the following syntax in your payload: `{{> your_snippet_name }}` to reference the snippet content within a notification or rich message. See [Snippets](/docs/guides/personalization/content/snippets/) to see how to create a snippet in the Airship dashboard. **Used in:** - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) **Examples** *Example push object* ```json { "audience": { "OR": [ { "tag": [ "sports", "entertainment" ] }, { "ios_channel": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5" } ] }, "notification": { "alert": "Hi from Airship!{{#if super_sale }} We're having a sale on {{ products.0.name }}!{{/if}}", "ios": { "extra": { "url": "http://www.urbanairship.com" } } }, "options": { "expiry": "2020-04-01T12:00:00" }, "message": { "title": "Message title", "body": "", "content_type": "text/html" }, "in_app": { "alert": "This part appears in-app!", "display_type": "banner", "expiry": "2020-04-01T12:00:00", "display": { "position": "top" } }, "device_types": [ "ios", "android" ], "global_attributes": { "super_sale": true, "products": [ {"id": 1, "name": "New Line Sneakers", "price": "79.95"}, {"id": 2, "name": "Old Line Sneakers", "price": "59.95"} ] } } ``` *Example personalized push* ```json { "device_types": [ "sms" ], "options": { "personalization": true }, "notification": { "sms": { "alert": "Hi {{name}}, {{#feed \"weather_updates\" kw="today" as |weather|}}It's going to be {{weather.temp}} in {{weather.loc}} today!{{/feed}}", } }, "audience": { "tag": "local_updates", "group": "weather" }, "feeds": [ { "name": "weather_updates", "params": { "kw": "today" } } ] } ``` *Example localized push* ```json { "device_types": [ "ios", "android" ], "audience": { "tag": "needs_a_greeting", "group": "new_customer" }, "notification": { "alert": "Hi!" }, "localizations": [ { "language": "de", "country": "AT", "notification": { "alert": "Grüss Gott" } }, { "language": "de", "country": "DE", "notification": { "alert": "Guten Tag" } } ] } ``` --- ## Push options {#pushoptions} A JSON dictionary for specifying non-payload options related to the delivery of the push. - **`audience_limits`** `object` <[Audience limits object]({{< ref "/developer/rest-api/ua/schemas/audience-limits/" >}}#audiencelimitsobject)> Defines limits to be applied to Push Notifications and standard in-app messages (not In-App Automations or Scenes) only. See [Audience Limit](/docs/guides/messaging/messages/delivery/delivery/#audience-limit) in the *Message delivery* user guide for additional information and limitations. - **`ban_list_parameters`** `object` <[Ban List parameters]({{< ref "/developer/rest-api/ua/schemas/audience-limits/" >}}#banlistparametersobject)> A list of parameters, where the key and value are both strings, that will be used to override the default values set for variables in a [Ban List](/docs/guides/audience/segmentation/ban-lists/) request URL. - **`bypass_ban_list_processing`** `boolean` If true, a user's status on a [Ban List](/docs/guides/audience/segmentation/ban-lists/) will not be verified before sending the push. Default: `false` - **`bypass_frequency_limits`** `boolean` If true, the push ignores any [Message Limits](/docs/guides/messaging/project/config/message-limits/) that would otherwise apply to your message. Default: `false` - **`bypass_holdout_groups`** `boolean` If true, the push ignores withholding any messages for users in a holdout group for a [Holdout Experiment](/docs/guides/experimentation/holdout-experiments/) that is active at send time. Default: `false` - **`expiry`** `object` Delivery expiration, as either absolute ISO UTC timestamp, or number of seconds from now. **One of:** - `integer` Number of seconds from now. When the delivery platform supports it, a value of zero (0) indicates that the message should be delivered immediately and never stored for later attempts. - `string` A [date-time](/docs/developer/rest-api/ua/introduction/#date-time-format). - **`no_throttle`** `boolean` If true, the push will ignore global throttling rates that have been configured for the application, resulting in delivery as quickly as possible. Default: `false` - **`omit_from_activity_log`** `boolean` If true, the push is omitted from the [Activity Log](/docs/guides/reports/activity-log/). Default: `false` - **`personalization`** `boolean` If true, enables Handlebars-style template syntax for eligible fields in a [notification](/docs/developer/rest-api/ua/schemas/others/#notificationobject) or [message center](/docs/developer/rest-api/ua/schemas/others/#messageobject) objects. You can do this to enable handlebars for all available fields without using individual `template` objects for different platform overrides. This setting is implicitly true whenever your payload includes a [platform override](/docs/developer/rest-api/ua/schemas/platform-overrides/) with a `template` object. Default: `false` - **`redact_payload`** `boolean` If true, the push payload will not appear in Airship's logs. You cannot use this option with Message Center, A/B Tests, Automation, or Scheduled pushes, which all require the payload to be stored separately by design. Default: `false` - **`use_strict_sms_validation`** `boolean` This field is only compatible for [Create and Send](/docs/developer/rest-api/ua/operations/bulk-sending/#createandsend) requests targeting `SMS` and `MMS` `device_types`. If true, Create and Send requests containing any selector entries that would result in silent row drops will return a `400 Bad Request` response code. Detailed error messages will be returned for all invalid rows. If false, requests that contain row entries with silent errors as documented for the targeted required selector fields will return a `200` status code. However, all invalid entries will be **silently** dropped during request processing. By default, this attribute is implicitly set to `false` unless every entry in the request would be dropped silently as determined by the targeted selector type, at least one malformed JSON error is found in the request, or at least one validation error is encountered for a required selector field that is not documented to handle invalid data with silent drops. **Used in:** - [Create experiment (A/B Test)]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#createexperiment) - [Create pipeline (automated message)]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#createpipeline) - [Experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiments) - [Experiment lookup]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getexperiment) - [Individual pipeline lookup]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipeline) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List existing pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getpipelines) - [List filtered pipelines]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#getfilteredpipelines) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Scheduled experiment listing]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#getscheduledexperiments) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#updatepipeline) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate experiment]({{< ref "/developer/rest-api/ua/operations/a-b-tests/" >}}#validateexperiment) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) - [Validate pipeline]({{< ref "/developer/rest-api/ua/operations/automation/" >}}#validatepipeline) --- ## Snippet references object {#snippetreferences} An object used to indicate that a set of snippets should be loaded for use in message content. Use the following syntax in your payload: `{{> your_snippet_name }}` to reference the snippet content within a notification or rich message. See [Snippets](/docs/guides/personalization/content/snippets/) to see how to create a snippet in the Airship dashboard. {{< note >}} Make sure that the location where you are using a snippet supports the content defined in the snippet. For example, an image URL or HTML will not render in a push notification since push notifications only support plain text. {{< /note >}} [Jump to examples ↓](#snippetreferences-examples) - **`snippets`** `array[object]` **REQUIRED** An array of snippets that you want to use to personalize your message. **Used in:** - [Create content template]({{< ref "/developer/rest-api/ua/operations/content/" >}}#createcontenttemplate) - [Create or update content template by external ID]({{< ref "/developer/rest-api/ua/operations/content/" >}}#updatecontenttemplatebyexternalid) - [List a specific schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedule) - [List content templates]({{< ref "/developer/rest-api/ua/operations/content/" >}}#listcontenttemplates) - [List schedules]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#getschedules) - [Look up a content template]({{< ref "/developer/rest-api/ua/operations/content/" >}}#getcontenttemplate) - [Look up a content template by external ID]({{< ref "/developer/rest-api/ua/operations/content/" >}}#getcontenttemplatebyexternalid) - [Schedule a notification]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#schedulenotification) - [Schedule a templated push]({{< ref "/developer/rest-api/ua/operations/personalization/" >}}#scheduletemplatedpush) - [Schedule message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#schedulebulksendpush) - [Send a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#sendpush) - [Send message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#bulksendpush) - [Update content template]({{< ref "/developer/rest-api/ua/operations/content/" >}}#updatecontenttemplate) - [Update schedule]({{< ref "/developer/rest-api/ua/operations/schedules/" >}}#updateschedule) - [Validate a push]({{< ref "/developer/rest-api/ua/operations/push/" >}}#validatepush) - [Validate message with bulk ID]({{< ref "/developer/rest-api/ua/operations/bulk-sending/" >}}#validatebulksendpush) **Examples** *Example push snippets request* ```http POST /api/push HTTP/1.1 Authorization: Basic Accept: application/vnd.urbanairship+json; version=3 Content-Type: application/json { "device_types": ["ios"], "audience": { "tag": "earlyBirds" }, "notification": { "alert": "Hello, {{user}}, how are you today?{{> \"signoff\" }}" }, "options": { "personalization": true }, "snippet_references": { "snippets": [ { "name": "signoff" } ] } } ``` ```http HTTP/1.1 202 Accepted Content-Type: application/vnd.urbanairship+json; version=3 Content-Length: 123 Data-Attribute: push_ids { "ok": true, "operation_id": "5e7852b0-6909-4e60-a73f-4d6b92d94c80", "push_ids": [ "bf28d158-fefe-475a-9c2a-ed4f69cc891e" ] } ``` *Snippet references example: The `copyright` snippet is loaded by the `snippet_references` object and inserted at the end of the `alert` text. * ```json { "notification": { "alert": "Hi {{ name }}: Thanks for your purchase! {{> copyright }}" }, "snippet_references": { "snippets": [ { "name": "copyright" } ] } } ``` ---