Airship
App · 25 actions
Send, check and schedule push notifications with Airship, the mobile app engagement platform: to a named user, a device, a tag, a segment or a static list. Keep named users' channels, tags and attributes in step, send custom events, manage static lists and read push reports. Start a workflow when a push is sent or scheduled, or a segment or list changes.
Actions
| Action | What it does |
|---|---|
| Add channel to named user | Link a channel (a device) or an email address to a named user, such as when someone signs in, so pushes to them reach it. |
| Create static list | Make an empty static list (a list of people you keep yourself, such as loyalty members) to fill with 'Replace static list members'. |
| Delete named user | Delete a named user and uninstall every channel linked to them, removing their data from Airship, such as for a privacy request. |
| Delete scheduled push | Delete a scheduled push notification so it is never sent. |
| Delete static list | Delete a static list. |
| Get channel | Get a channel (a device, email address or phone number): its platform, whether it takes notifications, its named user and tags. |
| Get named user | Get a named user with their tags, attributes and linked channels. |
| Get push results | Get one push notification's results: when it was sent, to how many devices, and how many people opened the app from it. |
| Get scheduled push | Get one scheduled push notification: when it goes out, who it goes to and what it says. |
| Get segment | Get a segment's name and the rules that pick its audience. |
| Get sends report | Count the push notifications sent on each platform in a time range, hour by hour, day by day or month by month. |
| Get static list | Get a static list's status (ready, processing or failure) and how many channels it reaches. |
| List pushes with results | List the push notifications sent in a time range, with how many were sent and how many people opened the app from each. |
| List scheduled pushes | List the project's scheduled push notifications with when each goes out and who it goes to. |
| List segments | List the project's segments with when each was made and last changed. |
| List static lists | List the project's static lists with their status and size. |
| Remove channel from named user | Unlink a channel (a device) or an email address from a named user, such as when someone signs out. |
| Replace static list members | Replace everyone on a static list with these named users and channels. |
| Schedule push notification | Schedule a push notification for a moment, or for a time of day in each device's own time zone, with the same choices as 'Send push notification'. |
| Send custom event | Record something a person did outside the app, such as a purchase, for a named user or a channel. |
| Send push notification | Send a push notification now to a named user, a channel, everyone with a tag, a segment, a static list or everyone, with a title, what a tap opens and extra data for the app. |
| Set named user attributes | Set or remove a named user's attributes, such as first_name or loyalty_points. |
| Update channel tags | Add or remove a channel's tags in one tag group, or replace the group's tags. |
| Update named user tags | Add or remove a named user's tags in one tag group, or replace the group's tags. |
| Validate push notification | Have Airship check a push notification exactly as 'Send push notification' would build it, without sending it to anyone. |
Add channel to named user
Link a channel (a device) or an email address to a named user, such as when someone signs in, so pushes to them reach it. A channel linked to someone else moves to this named user.
Inputs
- Named user
named_usertextRequired - The named user's ID: the ID your app gives the person in Airship, such as customer-42.
- Channel ID
channel_idtext - The channel to link, such as 9c36e8c7-5a73-47c0-9716-99fd3d4197d5. Give this or an email address.
- Email address
email_addresstext - An email address registered in Airship, to link instead of a channel.
- Platform
platformtext - The channel's platform. Only needed for a channel registered in the last few minutes.One of:
ios,android,amazon(Fire OS (Amazon)),web(Web browser),email,sms,open(Open channel).
Outputs
associatedtrue/false- True once Airship accepted it; it applies in moments
channel_idtext- The channel linked; empty when an email address was
email_addresstext- The email address linked; empty when a channel was
named_user_idtext- The named user
Example output
{
"associated": true,
"channel_id": "dceafd02-b852-4305-83df-98b65fa40dd4",
"email_address": "",
"named_user_id": "customer-42"
}Create static list
Make an empty static list (a list of people you keep yourself, such as loyalty members) to fill with 'Replace static list members'.
Inputs
- Name
nametextRequired - The list's name, up to 64 characters, such as platinum_members. It can't be changed or reused.
- Description
descriptiontext - What the list is for.
- Extra data
extraobject - Names and values to keep with it, such as {"source": "crm"}.
Outputs
createdtrue/false- True once Airship made it
descriptiontext- Its description
extraobject- Its extra key-value data
nametext- The new list's name
Example output
{
"created": true,
"description": "loyalty program platinum members",
"extra": {
"key": "value"
},
"name": "platinum_members"
}Delete named user
Delete a named user and uninstall every channel linked to them, removing their data from Airship, such as for a privacy request. It can't be undone.
Inputs
- Named user
named_usertextRequired - The named user's ID: the ID your app gives the person in Airship, such as customer-42.
Outputs
deletedtrue/false- True once Airship accepted it; uninstalling takes a little while
named_user_idtext- The named user deleted
Example output
{
"deleted": true,
"named_user_id": "customer-42"
}Delete scheduled push
Delete a scheduled push notification so it is never sent. It can't be undone.
Inputs
- Schedule ID
schedule_idtextRequired - The schedule's ID, from 'Schedule push notification' or 'List scheduled pushes'.
Outputs
deletedtrue/false- Always true once deleted
schedule_idtext- The schedule deleted
Example output
{
"deleted": true,
"schedule_id": "eac2ace6-349a-41a2-b874-5496d7bf0100"
}Delete static list
Delete a static list. Its name can't be used for a new list afterwards.
Inputs
- Static list
static_listtextRequired - The list to delete, or its name.
Outputs
deletedtrue/false- Always true once deleted
nametext- The list deleted
Example output
{
"deleted": true,
"name": "platinum_members"
}Get channel
Get a channel (a device, email address or phone number): its platform, whether it takes notifications, its named user and tags.
Inputs
- Channel ID
channel_idtextRequired - The channel's ID, such as 9c36e8c7-5a73-47c0-9716-99fd3d4197d5.
Outputs
addresstext- Its email address or open channel address; empty for a device
channel_idtext- The channel's ID
createdtext- When it was registered (UTC)
installedtrue/false- False once the app was uninstalled
last_registrationtext- When it last checked in (UTC)
named_user_idtext- The named user it belongs to; empty if none
opted_intrue/false- True when it takes notifications
platformtext- Its platform: ios, android, amazon, web, email, sms or open
tag_groupsobject- Its tags, by tag group
tagslist- Its primary device tags
Example output
{
"address": "",
"channel_id": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5",
"created": "2020-08-08T20:41:06",
"installed": true,
"last_registration": "2020-05-01T18:00:27",
"named_user_id": "some_id_that_maps_to_your_systems",
"opted_in": false,
"platform": "ios",
"tag_groups": {
"tag_group_1": [
"tag1",
"tag2"
],
"tag_group_2": [
"tag1",
"tag2"
]
},
"tags": [
"tag1",
"tag2"
]
}Get named user
Get a named user with their tags, attributes and linked channels.
Inputs
- Named user
named_usertextRequired - The named user's ID: the ID your app gives the person in Airship, such as customer-42.
Outputs
attributesobject- Their attributes, by attribute ID
channel_countnumber- How many channels are linked to them
channelslist- The channels (devices, email addresses) linked to them
createdtext- When Airship first saw them (UTC)
last_modifiedtext- When they last changed (UTC)
named_user_idtext- The named user's ID
tagsobject- Their tags, by tag group, such as {"loyalty": ["gold"]}
Example output
{
"attributes": {
"item_purchased": "Fur removal tool",
"pets_age": 12
},
"channel_count": 1,
"channels": [
{
"channel_id": "dceafd02-b852-4305-83df-98b65fa40dd4",
"created": "2020-04-08T20:41:06",
"installed": true,
"last_registration": "2020-05-01T18:00:27",
"opted_in": true,
"platform": "ios"
}
],
"created": "2020-04-08T20:41:06",
"last_modified": "2020-05-01T18:00:27",
"named_user_id": "user-456",
"tags": {
"my_fav_tag_group": [
"tag1",
"tag2"
]
}
}Get push results
Get one push notification's results: when it was sent, to how many devices, and how many people opened the app from it.
Inputs
- Push ID
push_idtextRequired - The push's ID, from 'Send push notification' or 'List pushes with results'.
Outputs
direct_responsesnumber- How many people opened the app from it
group_idtext- The group it belongs to (an automation or local-time send)
open_channel_sendsnumber- How many it was sent to on open channels
open_channelslist- Sends on each open channel platform
push_idtext- The push's ID
push_timetext- When it was sent (UTC)
push_typetext- What kind of push it was, such as BROADCAST_PUSH, TAG_PUSH, SEGMENTS_PUSH, SCHEDULED_PUSH or UNICAST_PUSH
sendsnumber- How many devices it was sent to on Airship's own platforms
Example output
{
"direct_responses": 15,
"group_id": "",
"open_channel_sends": 167,
"open_channels": [
{
"platform": "PLATFORM_NAME",
"sends": 22
},
{
"platform": "ANOTHER_PLATFORM",
"sends": 145
}
],
"push_id": "90f28bc6-6c9b-4c99-b970-973afc266e08",
"push_time": "2020-02-25 23:03:12",
"push_type": "UNICAST_PUSH",
"sends": 167
}Get scheduled push
Get one scheduled push notification: when it goes out, who it goes to and what it says.
Inputs
- Schedule ID
schedule_idtextRequired - The schedule's ID, from 'Schedule push notification' or 'List scheduled pushes'.
Outputs
audiencetext- Who it goes to, such as tag vip
messagetext- The notification's text
nametext- Its name; empty if it has none
pausedtrue/false- True when a repeating schedule is paused
platformslist- The platforms it is built for
push_idslist- The push IDs Airship gave it
recurringtrue/false- True for a schedule that repeats
schedule_idtext- The schedule's ID
send_attext- When it goes out (UTC, or each device's local time for a local one); a day for best_time
timingtext- How it is timed: exact (one moment), local (each device's time of day), best_time or recurring
urltext- Its address in Airship's API
Example output
{
"audience": "tag earlyBirds",
"message": "Good Day Sunshine",
"name": "Morning People",
"paused": false,
"platforms": [
"ios",
"android"
],
"push_ids": [
"83046227-9b06-4114-9f23-0df349792bbd"
],
"recurring": false,
"schedule_id": "eac2ace6-349a-41a2-b874-5496d7bf0100",
"send_at": "2026-12-03T09:15:00",
"timing": "exact",
"url": "https://go.urbanairship.com/api/schedules/eac2ace6-349a-41a2-b874-5496d7bf0100"
}Get segment
Get a segment's name and the rules that pick its audience.
Inputs
- Segment
segmenttextRequired - The segment, from the project's segments, or its ID.
Outputs
criteriaobject- The rules that pick its audience, as Airship writes them
nametext- Its name
segment_idtext- The segment's ID
Example output
{
"criteria": {
"and": [
{
"tag": "ipad"
},
{
"not": {
"tag": "foo"
}
}
]
},
"name": "A segment",
"segment_id": "00c0d899-a595-4c66-9071-bc59374bbe6b"
}Get sends report
Count the push notifications sent on each platform in a time range, hour by hour, day by day or month by month.
Inputs
- From
startdate and timeRequired - The start of the time range.
- To
enddate and timeRequired - The end of the time range.
- Split by
precisiontext - How to split the range. Defaults to days.One of:
DAILY,HOURLY,MONTHLY. Default:DAILY.
Outputs
periodslist- Each hour, day or month in the range
precisiontext- How the range is split: HOURLY, DAILY or MONTHLY
totalnumber- Pushes sent in the whole range
Example output
{
"periods": [
{
"by_platform": {
"android": 50,
"ios": 500
},
"date": "2020-05-01 00:00:00",
"total": 550
}
],
"precision": "MONTHLY",
"total": 550
}Get static list
Get a static list's status (ready, processing or failure) and how many channels it reaches.
Inputs
- Static list
static_listtextRequired - The list, or its name.
Outputs
channel_countnumber- How many channels the last good upload reaches
createdtext- When it was made (UTC)
descriptiontext- Its description
error_pathtext- A link to the last upload's errors; empty if none
extraobject- Its extra key-value data
last_updatedtext- When its members last changed (UTC)
nametext- The list's name
statustext- ready (it can be sent to), processing (an upload is being read) or failure (the last upload failed)
Example output
{
"channel_count": 1000,
"created": "2020-04-08T20:41:06",
"description": "loyalty program platinum members",
"error_path": "",
"extra": {
"key": "value"
},
"last_updated": "2020-05-01T18:00:27",
"name": "platinum_members",
"status": "ready"
}List pushes with results
List the push notifications sent in a time range, with how many were sent and how many people opened the app from each.
Inputs
- From
startdate and timeRequired - The start of the time range.
- To
enddate and timeRequired - The end of the time range.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
Outputs
countnumber- How many are listed
pusheslist- The pushes, newest first as Airship lists them
Example output
{
"count": 1,
"pushes": [
{
"direct_responses": 0,
"group_id": "4e768dc7-4ebc-4206-890a-60b5627763a7",
"open_channel_sends": 0,
"open_channels": [],
"push_id": "f4db3752-a982-4a2b-994e-7b5fd1c7f02f",
"push_time": "2020-08-15 02:12:22",
"push_type": "UNICAST_PUSH",
"sends": 1
}
]
}List scheduled pushes
List the project's scheduled push notifications with when each goes out and who it goes to.
Inputs
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 1000.
Outputs
countnumber- How many are listed
scheduleslist- The scheduled pushes
totalnumber- How many the project has
Example output
{
"count": 1,
"schedules": [
{
"audience": "tag earlyBirds",
"message": "Good Day Sunshine",
"name": "Morning People",
"paused": false,
"platforms": [
"ios",
"android"
],
"push_ids": [
"83046227-9b06-4114-9f23-0df349792bbd"
],
"recurring": false,
"schedule_id": "eac2ace6-349a-41a2-b874-5496d7bf0100",
"send_at": "2026-12-03T09:15:00",
"timing": "exact",
"url": "https://go.urbanairship.com/api/schedules/eac2ace6-349a-41a2-b874-5496d7bf0100"
}
],
"total": 1
}List segments
List the project's segments with when each was made and last changed.
Inputs
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 1000.
Outputs
countnumber- How many are listed
segmentslist- The segments
Example output
{
"count": 1,
"segments": [
{
"created_at": "2012-08-29T14:00:22Z",
"name": "A segment",
"segment_id": "00c0d899-a595-4c66-9071-bc59374bbe6b",
"updated_at": "2012-08-29T14:00:22Z"
}
]
}List static lists
List the project's static lists with their status and size.
Inputs
None.
Outputs
countnumber- How many there are
listslist- The static lists
Example output
{
"count": 1,
"lists": [
{
"channel_count": 1000,
"created": "2020-04-08T20:41:06",
"description": "loyalty program platinum members",
"error_path": "",
"extra": {
"key": "value"
},
"last_updated": "2020-05-01T18:00:27",
"name": "platinum_members",
"status": "ready"
}
]
}Remove channel from named user
Unlink a channel (a device) or an email address from a named user, such as when someone signs out.
Inputs
- Named user
named_usertextRequired - The named user's ID: the ID your app gives the person in Airship, such as customer-42.
- Channel ID
channel_idtext - The channel to unlink, such as 9c36e8c7-5a73-47c0-9716-99fd3d4197d5. Give this or an email address.
- Email address
email_addresstext - An email address registered in Airship, to unlink instead of a channel.
- Platform
platformtext - The channel's platform. Only needed for a channel registered in the last few minutes.One of:
ios,android,amazon(Fire OS (Amazon)),web(Web browser),email,sms,open(Open channel).
Outputs
channel_idtext- The channel unlinked; empty when an email address was
disassociatedtrue/false- True once Airship accepted it; it applies in moments
email_addresstext- The email address unlinked; empty when a channel was
named_user_idtext- The named user
Example output
{
"channel_id": "dceafd02-b852-4305-83df-98b65fa40dd4",
"disassociated": true,
"email_address": "",
"named_user_id": "customer-42"
}Replace static list members
Replace everyone on a static list with these named users and channels. Airship processes the upload in a few moments.
Inputs
- Static list
static_listtextRequired - The list to fill, or its name.
- Named users
named_userslist - The named users on the list, one per row.
- Channel IDs
channel_idslist - Channels on the list, one per row, all on one platform.
- Channels' platform
channel_platformtext - The platform the channel IDs are on.One of:
ios,android,amazon(Fire OS (Amazon)),web(Web browser),email,sms,open(Open channel).
Outputs
channelsnumber- How many channels were uploaded
nametext- The list
named_usersnumber- How many named users were uploaded
statustext- processing: Airship reads the upload in the background
Example output
{
"channels": 0,
"name": "platinum_members",
"named_users": 2,
"status": "processing"
}Schedule push notification
Schedule a push notification for a moment, or for a time of day in each device's own time zone, with the same choices as 'Send push notification'.
Inputs
- Name
nametext - A name to find it by in Airship, such as Weekly digest.
- When
timingtext - One moment for everyone, or a time of day in each device's own time zone.One of:
exact(At one moment everywhere),local(At a time of day in each device's own time zone). Default:exact. - Send at
send_atdate and time - When to send it. It must be in the future.Only when When is At one moment everywhere.
- Day
local_datedate - The day to send it on, in each device's time zone.Only when When is At a time of day in each device's own time zone.
- Time of day
local_timetime - The time of day it arrives on each device, such as 09:00.Only when When is At a time of day in each device's own time zone.
- Send to
audience_typetext - Who gets it. Defaults to a named user.One of:
named_user(A named user),channel(One channel (a device)),tag(Everyone with a tag),segment(A segment),static_list(A static list),all(Everyone). Default:named_user. - Named user
named_usertext - The named user's ID, such as customer-42. Every device linked to them gets it.Only when Send to is A named user.
- Channel ID
channel_idtext - The channel's ID, such as 9c36e8c7-5a73-47c0-9716-99fd3d4197d5: one iOS, Android, Fire OS or web device.Only when Send to is One channel (a device).
- Tag
tagtext - Everyone with this tag gets it, such as vip.Only when Send to is Everyone with a tag.
- Tag group
tag_grouptext - The tag's group key, such as loyalty. Leave blank for a device's own tags.Only when Send to is Everyone with a tag.
- Segment
segmenttext - The segment, from the project's segments, or its ID.Only when Send to is A segment.
- Static list
static_listtext - The static list, or its name.Only when Send to is A static list.
- Message
alerttextRequired - The notification's text.
- Title
titletext - A title shown above the text, on each platform that shows one.
- When tapped
on_taptext - What tapping the notification opens. Defaults to the app.One of:
app(Open the app),deep_link(Open a deep link in the app),url(Open a web page). Default:app. - Link
linktext - The deep link, such as myapp://orders/1234, or the web page, such as https://example.com/sale.Only when When tapped is Open a deep link in the app or Open a web page.
- Platforms
platformslist - The platforms to build it for. Leave blank for iOS and Android, or the channel's own platform.One or more of:
ios,android,amazon(Fire OS (Amazon)),web(Web browsers). - Extra data
extraobject - Names and values the app receives with it, such as {"order_id": "1234"}.
Outputs
audiencetext- Who it goes to, such as tag vip
messagetext- The notification's text
nametext- Its name; empty if it has none
operation_idtext- Airship's ID for the request, for its support team
pausedtrue/false- True when a repeating schedule is paused
platformslist- The platforms it is built for
push_idslist- The push IDs Airship gave it
recurringtrue/false- True for a schedule that repeats
schedule_idtext- The schedule's ID
send_attext- When it goes out (UTC, or each device's local time for a local one); a day for best_time
timingtext- How it is timed: exact (one moment), local (each device's time of day), best_time or recurring
urltext- Its address in Airship's API
Example output
{
"audience": "tag earlyBirds",
"message": "Good Day Sunshine",
"name": "Morning People",
"operation_id": "df6a6b50-9843-0304-d5a5-743f246a4946",
"paused": false,
"platforms": [
"ios",
"android"
],
"push_ids": [
"83046227-9b06-4114-9f23-0df349792bbd"
],
"recurring": false,
"schedule_id": "eac2ace6-349a-41a2-b874-5496d7bf0100",
"send_at": "2026-12-03T09:15:00",
"timing": "exact",
"url": "https://go.urbanairship.com/api/schedules/eac2ace6-349a-41a2-b874-5496d7bf0100"
}Send custom event
Record something a person did outside the app, such as a purchase, for a named user or a channel. Airship's automations and journeys can start on it.
Inputs
- Event name
event_nametextRequired - What happened, such as purchased. It is sent in lower case.
- Named user
named_usertext - The named user's ID: the ID your app gives the person in Airship, such as customer-42.
- Channel ID
channel_idtext - The channel it happened on, instead of a named user.
- Value
valuenumber - An amount for the event, such as 49.99.
- Properties
propertiesobject - Details messages can use, such as {"product": "Sneakers", "size": 42}.
- Happened at
occurred_atdate and time - When it happened, within the last 90 days. Defaults to now.
- Transaction
transactiontext - An ID tying several events together, such as an order number.
Outputs
event_nametext- The event's name, in lower case as Airship keeps it
operation_idtext- Airship's ID for the request, for its support team
senttrue/false- True once Airship accepted it
usertext- Who it happened to, such as named user customer-42
Example output
{
"event_name": "purchased",
"operation_id": "8c61c0c4-95b0-45a6-bc38-733f7fcb8979",
"sent": true,
"user": "named user hugh.manbeing"
}Send push notification
Send a push notification now to a named user, a channel, everyone with a tag, a segment, a static list or everyone, with a title, what a tap opens and extra data for the app.
Inputs
- Send to
audience_typetext - Who gets it. Defaults to a named user.One of:
named_user(A named user),channel(One channel (a device)),tag(Everyone with a tag),segment(A segment),static_list(A static list),all(Everyone). Default:named_user. - Named user
named_usertext - The named user's ID, such as customer-42. Every device linked to them gets it.Only when Send to is A named user.
- Channel ID
channel_idtext - The channel's ID, such as 9c36e8c7-5a73-47c0-9716-99fd3d4197d5: one iOS, Android, Fire OS or web device.Only when Send to is One channel (a device).
- Tag
tagtext - Everyone with this tag gets it, such as vip.Only when Send to is Everyone with a tag.
- Tag group
tag_grouptext - The tag's group key, such as loyalty. Leave blank for a device's own tags.Only when Send to is Everyone with a tag.
- Segment
segmenttext - The segment, from the project's segments, or its ID.Only when Send to is A segment.
- Static list
static_listtext - The static list, or its name.Only when Send to is A static list.
- Message
alerttextRequired - The notification's text.
- Title
titletext - A title shown above the text, on each platform that shows one.
- When tapped
on_taptext - What tapping the notification opens. Defaults to the app.One of:
app(Open the app),deep_link(Open a deep link in the app),url(Open a web page). Default:app. - Link
linktext - The deep link, such as myapp://orders/1234, or the web page, such as https://example.com/sale.Only when When tapped is Open a deep link in the app or Open a web page.
- Platforms
platformslist - The platforms to build it for. Leave blank for iOS and Android, or the channel's own platform.One or more of:
ios,android,amazon(Fire OS (Amazon)),web(Web browsers). - Extra data
extraobject - Names and values the app receives with it, such as {"order_id": "1234"}.
Outputs
audiencetext- Who it went to, such as named user customer-42
operation_idtext- Airship's ID for the request, for its support team
platformslist- The platforms it was built for, such as ios
push_idtext- The push's ID, for its report; the first if Airship made several
push_idslist- Every push ID Airship made for this send
Example output
{
"audience": "named user customer-42",
"operation_id": "df6a6b50-9843-0304-d5a5-743f246a4946",
"platforms": [
"ios",
"android"
],
"push_id": "9d78a53b-b16a-c58f-b78d-181d5e242078",
"push_ids": [
"9d78a53b-b16a-c58f-b78d-181d5e242078"
]
}Set named user attributes
Set or remove a named user's attributes, such as first_name or loyalty_points. Each must be added under Audience > Attributes first.
Inputs
- Named user
named_usertextRequired - The named user's ID: the ID your app gives the person in Airship, such as customer-42.
- Attributes to set
attributesobject - Attribute IDs and values, such as {"first_name": "Ada", "loyalty_points": 120}. Give dates as 2026-11-30.
- Attributes to remove
remove_attributeslist - Attribute IDs to clear.
Outputs
named_user_idtext- The named user
removedlist- The attribute IDs removed
setlist- The attribute IDs set
warningslist- Airship's warnings, such as an attribute the project doesn't have; empty when every change applied
Example output
{
"named_user_id": "customer-42",
"removed": [],
"set": [
"first_name",
"loyalty_points"
],
"warnings": []
}Update channel tags
Add or remove a channel's tags in one tag group, or replace the group's tags. Tags in the device group can be overwritten by the app itself.
Inputs
- Channel ID
channel_idtextRequired - The channel's ID, such as 9c36e8c7-5a73-47c0-9716-99fd3d4197d5.
- Tag group
tag_grouptextRequired - The tag group's key, from Audience > Tags > Tag Groups, such as loyalty.
- Tags to add
add_tagslist - Tags to add to the group. Others stay.
- Tags to remove
remove_tagslist - Tags to take out of the group.
- Replace the group's tags with
replace_tagslist - Every tag the group should have; the rest are removed. Not with tags to add or remove.
- Platform
platformtext - The channel's platform. Leave blank to have Airship look it up.One of:
ios,android,amazon(Fire OS (Amazon)),web(Web browser),email,sms,open(Open channel).
Outputs
addedlist- The tags added
channel_idtext- The channel
platformtext- Its platform
removedlist- The tags removed
replaced_withlist- The tags the group was set to, when it was replaced
tag_grouptext- The tag group changed
warningslist- Airship's warnings, such as a tag group that doesn't exist; empty when every change applied
Example output
{
"added": [
"gold"
],
"channel_id": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5",
"platform": "ios",
"removed": [],
"replaced_with": [],
"tag_group": "loyalty",
"warnings": []
}Update named user tags
Add or remove a named user's tags in one tag group, or replace the group's tags. The tag group must exist in the project.
Inputs
- Named user
named_usertextRequired - The named user's ID: the ID your app gives the person in Airship, such as customer-42.
- Tag group
tag_grouptextRequired - The tag group's key, from Audience > Tags > Tag Groups, such as loyalty.
- Tags to add
add_tagslist - Tags to add to the group. Others stay.
- Tags to remove
remove_tagslist - Tags to take out of the group.
- Replace the group's tags with
replace_tagslist - Every tag the group should have; the rest are removed. Not with tags to add or remove.
Outputs
addedlist- The tags added
named_user_idtext- The named user
removedlist- The tags removed
replaced_withlist- The tags the group was set to, when it was replaced
tag_grouptext- The tag group changed
warningslist- Airship's warnings, such as a tag group that doesn't exist; empty when every change applied
Example output
{
"added": [
"gold"
],
"named_user_id": "customer-42",
"removed": [
"silver"
],
"replaced_with": [],
"tag_group": "loyalty",
"warnings": []
}Validate push notification
Have Airship check a push notification exactly as 'Send push notification' would build it, without sending it to anyone.
Inputs
- Send to
audience_typetext - Who gets it. Defaults to a named user.One of:
named_user(A named user),channel(One channel (a device)),tag(Everyone with a tag),segment(A segment),static_list(A static list),all(Everyone). Default:named_user. - Named user
named_usertext - The named user's ID, such as customer-42. Every device linked to them gets it.Only when Send to is A named user.
- Channel ID
channel_idtext - The channel's ID, such as 9c36e8c7-5a73-47c0-9716-99fd3d4197d5: one iOS, Android, Fire OS or web device.Only when Send to is One channel (a device).
- Tag
tagtext - Everyone with this tag gets it, such as vip.Only when Send to is Everyone with a tag.
- Tag group
tag_grouptext - The tag's group key, such as loyalty. Leave blank for a device's own tags.Only when Send to is Everyone with a tag.
- Segment
segmenttext - The segment, from the project's segments, or its ID.Only when Send to is A segment.
- Static list
static_listtext - The static list, or its name.Only when Send to is A static list.
- Message
alerttextRequired - The notification's text.
- Title
titletext - A title shown above the text, on each platform that shows one.
- When tapped
on_taptext - What tapping the notification opens. Defaults to the app.One of:
app(Open the app),deep_link(Open a deep link in the app),url(Open a web page). Default:app. - Link
linktext - The deep link, such as myapp://orders/1234, or the web page, such as https://example.com/sale.Only when When tapped is Open a deep link in the app or Open a web page.
- Platforms
platformslist - The platforms to build it for. Leave blank for iOS and Android, or the channel's own platform.One or more of:
ios,android,amazon(Fire OS (Amazon)),web(Web browsers). - Extra data
extraobject - Names and values the app receives with it, such as {"order_id": "1234"}.
Outputs
audiencetext- Who it would go to, such as named user customer-42
platformslist- The platforms it was built for, such as ios
validtrue/false- True when Airship accepted the push as it would send it
Example output
{
"audience": "named user customer-42",
"platforms": [
"ios",
"android"
],
"valid": true
}