Push to template

Changed on Jun 24, 2026

Send a push notification based on a template to a list of devices. The body of the request must be a single push template payload or an array of one or more push template payloads.

post/api/templates/push

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or OAuth 2
  Client credentials
  Token URLhttp://oauth2.{domain}.com/token
  Scopespsh
TypeScript
https://skmtc.dev/airship/apis/airship-api/docs/api/templates/push/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Response

The push notification has been accepted for processing.

okboolean required

If true, the operation completed successfully and returns an expected response.

operation_idstring uuid

A unique string identifying the operation, useful for reporting and troubleshooting.

push_idsstring[]

Example response

{
  "operation_id": "ef625038-70a3-41f1-826f-57bc11dd625a",
  "push_ids": [
    "00256e0b-b02f-4f12-a77f-4c3d57078330",
    "f59970d3-3d42-4584-907e-f5c57f5d46a1"
  ]
}

Changes

Jun 24, 202638241778b0c1 Revision changes
- breaking
  added the new required request property /////////
- breaking
  added the new required request property /////////
- breaking
  added the new required request property /////////
- breaking
  added the new required request property /////////
- breaking
  added the new required request property /////////
- breaking
  added the new required request property /////////
- breaking
  added the new required request property ////////
- breaking
  added the new required request property ////////
- breaking
  added the new required request property ////////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property //////////
- breaking
  added the new required request property //////////
- breaking
  added the new required request property //////////
- breaking
  added the new required request property //////////
- breaking
  added the new required request property //////////
- breaking
  added the new required request property //////////
- breaking
  added the new required request property /////////
- breaking
  added the new required request property /////////
- breaking
  added the new required request property /////////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  added the new required request property //////
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the ////// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the ////// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the ///// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the // request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the /////// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the /////// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the ////// request property oneOf list
- breaking
  removed subschema #1: All selector subschema #2: Tag selector subschema #3: Segment selector subschema #4: Channel selector subschema #5: Named User selector subschema #6: Fire OS channel selector subschema #7: Android channel selector subschema #8: Open channel selector subschema #9: SMS sender selector subschema #10: SMS ID selector subschema #11: Static list selector subschema #12: Subscription List selector subschema #17: Alias selector subschema #18: APID selector subschema #20: Triggered selector from the /// request property oneOf list
This list may be incomplete.
Apr 12, 20225a2789287bfb Revision changes
- info
  added the new scene_completed enum value to the request property ////////
- info
  added the new scene_completed enum value to the request property ////////
- info
  added the new scene_completed enum value to the request property ///////
- info
  added the new scene_completed enum value to the request property ////
- info
  added the new scene_completed enum value to the request property /////////
- info
  added the new scene_completed enum value to the request property /////////
- info
  added the new scene_completed enum value to the request property ////////
- info
  added the new scene_completed enum value to the request property /////
- info
  added the new scene_displayed enum value to the request property ////////
- info
  added the new scene_displayed enum value to the request property ////////
- info
  added the new scene_displayed enum value to the request property ///////
- info
  added the new scene_displayed enum value to the request property ////
- info
  added the new scene_displayed enum value to the request property /////////
- info
  added the new scene_displayed enum value to the request property /////////
- info
  added the new scene_displayed enum value to the request property ////////
- info
  added the new scene_displayed enum value to the request property /////
- info
  added the new scene_incomplete enum value to the request property ////////
- info
  added the new scene_incomplete enum value to the request property ////////
- info
  added the new scene_incomplete enum value to the request property ///////
- info
  added the new scene_incomplete enum value to the request property ////
- info
  added the new scene_incomplete enum value to the request property /////////
- info
  added the new scene_incomplete enum value to the request property /////////
- info
  added the new scene_incomplete enum value to the request property ////////
- info
  added the new scene_incomplete enum value to the request property /////
- info
  added the new survey_displayed enum value to the request property ////////
- info
  added the new survey_displayed enum value to the request property ////////
- info
  added the new survey_displayed enum value to the request property ///////
- info
  added the new survey_displayed enum value to the request property ////
- info
  added the new survey_displayed enum value to the request property /////////
- info
  added the new survey_displayed enum value to the request property /////////
- info
  added the new survey_displayed enum value to the request property ////////
- info
  added the new survey_displayed enum value to the request property /////
- info
  added the new survey_not_submitted enum value to the request property ////////
- info
  added the new survey_not_submitted enum value to the request property ////////
- info
  added the new survey_not_submitted enum value to the request property ///////
- info
  added the new survey_not_submitted enum value to the request property ////
- info
  added the new survey_not_submitted enum value to the request property /////////
- info
  added the new survey_not_submitted enum value to the request property /////////
- info
  added the new survey_not_submitted enum value to the request property ////////
- info
  added the new survey_not_submitted enum value to the request property /////
- info
  added the new survey_submitted enum value to the request property ////////
- info
  added the new survey_submitted enum value to the request property ////////
- info
  added the new survey_submitted enum value to the request property ///////
- info
  added the new survey_submitted enum value to the request property ////
- info
  added the new survey_submitted enum value to the request property /////////
- info
  added the new survey_submitted enum value to the request property /////////
- info
  added the new survey_submitted enum value to the request property ////////
- info
  added the new survey_submitted enum value to the request property /////

Operation history (3 revisions)