Airship API Authorization Reference

For information about each authentication method, see Airship API Security.

Authorization per authentication method

The following table indicates supported authentication methods per endpoint in the Airship API. See the column for each authentication method to understand what access it allows. For OAuth 2.0, it lists the scope that allows access to the endpoint.

Name and API reference	Endpoint	Basic Master	Bearer — All Access	Bearer — Audience Modification	Basic App	OAuth 2.0 scope
Send a Push	POST /api/push	✅	✅	❌	❌	Push
Validate Push	POST /api/push/validate	✅	✅	❌	❌	Push
Send message with bulk ID	POST /api/bulk-send	✅	✅	❌	❌	Push
Validate message with bulk ID	POST /api/bulk-send/validate	✅	✅	❌	❌	Push
Delete Multiple Messages from Inbox	POST /api/user/messages/batch-delete	✅	❌	❌	❌	❌
Delete Message from Inbox	DELETE /api/user/messages/{push_id}	✅	❌	❌	❌	❌
Channel Lookup	GET /api/channels/{channel_id}	✅	✅	✅	✅	Channels
Set or Remove Attributes on Channels	POST /api/channels/attributes	✅	✅	✅	✅	Channels
Channel Tags	POST /api/channels/tags	✅	✅	✅	✅ 1	Channels
Channel Listing	GET /api/channels	✅	✅	✅	❌	Channels
Subscribe or Unsubscribe Channels to/from Subscription Lists	POST /api/channels/subscription_lists	✅	✅	✅	✅	Channels
Uninstall Channels	POST /api/channels/uninstall	✅	✅	✅	❌	Channels
Register New / Update Channel	POST /api/channels/open	✅	✅	✅	❌	Channels
Open Channel Tags	POST /api/channels/open/tags	✅	✅	✅	❌	Channels
Uninstall Open Channels	POST /api/channels/open/uninstall	✅	✅	✅	❌	Channels
Register Email Channel	POST /api/channels/email	✅	✅	✅	❌	Channels
Replace Email Channel	POST /api/channels/email/replace/{channel_id}	✅	✅	✅	❌	Channels
Suppress an Email Channel	POST /api/channels/email/suppress	✅	✅	✅	❌	Channels
Email Tags	POST /api/channels/email/tags	✅	✅	✅	❌	Channels
Uninstall Email Channel	POST /api/channels/email/uninstall	✅	✅	✅	❌	Channels
Remove Suppression from an Email Channel	POST /api/channels/email/unsuppress	✅	✅	✅	❌	Channels
Look Up an Email Address	GET /api/channels/email/{email}	✅	✅	✅	❌	Channels
Update an Email Channel	PUT /api/channels/email/{email}	✅	✅	✅	❌	Channels
Register SMS Channel	POST /api/channels/sms	✅	✅	✅	❌	Channels
Opt-out of SMS messages	POST /api/channels/sms/opt-out	✅	✅	✅	❌	Channels
SMS Tags	POST /api/channels/sms/tags	✅	✅	✅	❌	Channels
Uninstall SMS Channel	POST /api/channels/sms/uninstall	✅	✅	✅	❌	Channels
Update SMS Channel	PUT /api/channels/sms/{channel_id}	✅	✅	✅	❌	Channels
SMS Channel Lookup	GET /api/channels/sms/{msisdn}/{sender}	✅	✅	✅	❌	Channels
Custom Unsubscribe Email Channel	GET /api/channels/email/custom-unsubscribe	n/a	n/a	n/a	n/a	n/a
Create Email Attachment	POST /api/attachments	✅	✅	✅	❌	Attachments
Named User Listing or Lookup	GET /api/named_users	✅	✅	✅	❌	Named Users
Named Users Association	POST /api/named_users/associate	✅	✅	✅	✅	Named Users
Named Users Disassociation	POST /api/named_users/disassociate	✅	✅	✅	✅	Named Users
Scoped Named User Batch Operations	POST /api/named_users/scoped/{named_user_id}	✅	✅	✅	✅	Named Users
Named Users Tags	POST /api/named_users/tags	✅	✅	✅	✅	Named Users
Named User Update	POST /api/named_users/{named_user_id}	✅	✅	✅	✅	Named Users
Set or Remove Attributes on Named Users	POST /api/named_users/{named_user_id}/attributes	✅	✅	✅	✅	Named Users
Named Users Uninstall	POST /api/named_users/uninstall	✅	✅	✅	❌	Named Users
Named User Subscription Lists Listing	GET /api/subscription_lists/named_users/{named_user_id}	✅	✅	✅	❌	Named Users
Subscription Lists Listing	GET /api/subscription_lists	✅	✅	✅	❌	Lists
Create and Send	POST /api/create-and-send	✅	✅	❌	❌	Push
Validate Create and Send Payload	POST /api/create-and-send/validate	✅	✅	❌	❌	Push
Create bulk send audience	POST /api/bulk/{platform_name}	✅	✅	❌	❌	Push
Schedule a Create and Send message	POST /api/schedules/create-and-send	✅	✅	❌	❌	Push
Schedule message with bulk ID	POST /api/schedules/bulk-send	✅	✅	❌	❌	Push
List Schedules	GET /api/schedules	✅	✅	❌	❌	Schedules
Schedule a Notification	POST /api/schedules	✅	✅	❌	❌	Schedules
List a Specific Schedule	GET /api/schedules/{schedule_id}	✅	✅	❌	❌	Schedules
Update Schedule	PUT /api/schedules/{schedule_id}	✅	✅	❌	❌	Schedules
Delete Schedule	DELETE /api/schedules/{schedule_id}	✅	✅	❌	❌	Schedules
Pause a Schedule	POST /api/schedules/{schedule_id}/pause	✅	✅	❌	❌	Schedules
Resume a Schedule	POST /api/schedules/{schedule_id}/resume	✅	✅	❌	❌	Schedules
List Existing Pipelines	GET /api/pipelines	✅	✅	❌	❌	Pipelines
Create Pipeline (Automated Message)	POST /api/pipelines	✅	✅	❌	❌	Pipelines
List Pipelines Constraints	GET /api/pipelines/constraints	✅	✅	❌	❌	Pipelines
Update Pipelines Constraints	PUT /api/pipelines/constraints	✅	✅	❌	❌	Pipelines
List Deleted Pipelines	GET /api/pipelines/deleted	✅	✅	❌	❌	Pipelines
List Filtered Pipelines	GET /api/pipelines/filtered	✅	✅	❌	❌	Pipelines
List Pipelines Limits	GET /api/pipelines/limits	✅	✅	❌	❌	Pipelines
Validate Pipeline	POST /api/pipelines/validate	✅	✅	❌	❌	Pipelines
Individual Pipeline Lookup	GET /api/pipelines/{pipeline_id}	✅	✅	❌	❌	Pipelines
Update Pipeline	PUT /api/pipelines/{pipeline_id}	✅	✅	❌	❌	Pipelines
Delete Pipeline	DELETE /api/pipelines/{pipeline_id}	✅	✅	❌	❌	Pipelines
Retrieve (Attributes) Lists	GET /api/attribute-lists	✅	✅	✅	❌	Lists
Create Attributes List	POST /api/attribute-lists	✅	✅	✅	❌	Lists
Upload Attribute List	PUT /api/attribute-lists/{list_name}/csv	✅	✅	✅	❌	Lists
Download (Attributes) List Errors	GET /api/attribute-lists/{list_name}/errors	✅	✅	✅	❌	Lists
(Retrieve) All (Static) Lists	GET /api/lists	✅	✅	✅	❌	Lists
Create (Static) List	POST /api/lists	✅	✅	✅	❌	Lists
Get Single (Static) List Metadata	GET /api/lists/{list_name}	✅	✅	✅	❌	Lists
Update (Static) List Metadata	PUT /api/lists/{list_name}	✅	✅	✅	❌	Lists
Delete a (Static) List	DELETE /api/lists/{list_name}	✅	✅	✅	❌	Lists
Update (Static) List Contents	PUT /api/lists/{list_name}/csv	✅	✅	✅	❌	Lists
Download a List of Channels (from a Static List)	GET /api/lists/{list_name}/csv	✅	❌	❌	❌	Lists
Retrieve (Tag) Lists	GET /api/tag-lists	✅	✅	✅	❌	Lists
Delete Tag List	DELETE /api/tag-lists/{list_name}	✅	✅	✅	❌	Lists
Create a Tag List	POST /api/tag-lists	✅	✅	✅	❌	Lists
Upload Tag List	PUT /api/tag-lists/{list_name}/csv	✅	✅	✅	❌	Lists
Download (Tag) List Errors	GET /api/tag-lists/{list_name}/errors	✅	✅	✅	❌	Lists
Push to Template	POST /api/templates/push	✅	❌	❌	❌	Push
Validate a Template	POST /api/templates/push/validate	✅	❌	❌	❌	Push
Schedule a Templated Push	POST /api/templates/schedules	✅	❌	❌	❌	Push
List Templates	GET /api/templates	✅	❌	❌	❌	❌
Create Template	POST /api/templates	✅	❌	❌	❌	❌
Look up a Template	GET /api/templates/{template_id}	✅	❌	❌	❌	❌
Update Template	POST /api/templates/{template_id}	✅	❌	❌	❌	❌
Delete Template	DELETE /api/templates/{template_id}	✅	❌	❌	❌	❌
Segment Listing	GET /api/segments	✅	✅	✅	❌	❌
Create Segment	POST /api/segments	✅	✅	✅	❌	❌
Segment Lookup	GET /api/segments/{segment_id}	✅	✅	✅	❌	❌
Update Segment	PUT /api/segments/{segment_id}	✅	✅	✅	❌	❌
Delete Segment	DELETE /api/segments/{segment_id}	✅	✅	✅	❌	❌
Activity Log Report	GET /api/reports/activity/details	✅	✅	✅	❌	❌
Devices Report	GET /api/reports/devices	✅	✅	✅	❌	❌
Custom Events Detail Listing	GET /api/reports/events	✅	✅	✅	❌	❌
Custom Events Per Group Summary	GET /api/reports/events/summary/pergroup/{group_id}	✅	✅	✅	❌	❌
Custom Events Per Push Summary	GET /api/reports/events/summary/perpush/{push_id}	✅	✅	✅	❌	❌
Experiment Variant Report	GET /api/reports/experiment/detail/{push_id}/{variant_id}	✅	✅	✅	❌	❌
Experiment Overview Report	GET /api/reports/experiment/overview/{push_id}	✅	✅	✅	❌	❌
App Opens Report	GET /api/reports/opens	✅	✅	✅	❌	❌
Opt-in Report	GET /api/reports/optins	✅	✅	✅	❌	❌
Opt-out Report	GET /api/reports/optouts	✅	✅	✅	❌	❌
Per Group Push Detail Report	GET /api/reports/pergroup/detail/{group_id}	✅	✅	✅	❌	❌
Per Group Push Time Series Report	GET /api/reports/pergroup/series/{group_id}	✅	✅	✅	❌	❌
Per Push Detail Report	GET /api/reports/perpush/detail/{push_id}	✅	✅	✅	❌	❌
Push Body Per Push	GET /api/reports/perpush/pushbody/{push_id}	✅	✅	✅	❌	❌
Per Push Time Series Report	GET /api/reports/perpush/series/{push_id}	✅	✅	✅	❌	❌
Response Report	GET /api/reports/responses	✅	✅	✅	❌	❌
Response Listing	GET /api/reports/responses/list	✅	✅	✅	❌	❌
Individual Push Response Statistics	GET /api/reports/responses/{push_id}	✅	✅	✅	❌	❌
Push Report	GET /api/reports/sends	✅	✅	✅	❌	❌
Time in App Report	GET /api/reports/timeinapp	✅	✅	✅	❌	❌
Web Response Report	GET /api/reports/web/interaction	✅	✅	✅	❌	❌
Manually Trigger a Keyword Interaction	POST /api/sms/{msisdn}/keywords	✅	✅	✅	✅	❌
Add Custom Events	POST /api/custom-events	❌	✅	❌	❌	Events
Custom SMS Response	POST /api/sms/custom-response	❌	✅	❌	❌	❌
Experiment Listing	GET /api/experiments	✅	❌	❌	❌	❌
Create Experiment (A/B Test)	POST /api/experiments	✅	❌	❌	❌	❌
Scheduled Experiment Listing	GET /api/experiments/scheduled	✅	❌	❌	❌	❌
Delete Experiment	DELETE /api/experiments/scheduled/{experiment_id}	✅	❌	❌	❌	❌
Validate Experiment	POST /api/experiments/validate	✅	❌	❌	❌	❌
Experiment Lookup	GET /api/experiments/{experiment_id}	✅	❌	❌	❌	❌
Region Listing	GET /api/regions	✅	❌	❌	❌	❌
Region Lookup	GET /api/regions/{region_id}	✅	❌	❌	❌	❌

^{1. Tag operations done by application secret can only be made to a single channel.}

OAuth token scopes

Refer to the following sections when setting permissions for OAuth client credentials.

Attachments

The Attachments scope includes only the Create Email Attachment endpoint: POST /api/attachments.

Channels

Endpoints included in the Channels scope:

Name and API reference	Endpoint
Channel Listing	GET /api/channels
Set or Remove Attributes on Channels	POST /api/channels/attributes
Subscribe or Unsubscribe Channels to/from Subscription Lists	POST /api/channels/subscription_lists
Channel Tags	POST /api/channels/tags
Uninstall Channels	POST /api/channels/uninstall
Channel Lookup	GET /api/channels/{channel_id}
Register New / Update Channel	POST /api/channels/open
Open Channel Tags	POST /api/channels/open/tags
Uninstall Open Channels	POST /api/channels/open/uninstall
Register Email Channel	POST /api/channels/email
Replace Email Channel	POST /api/channels/email/replace/{channel_id}
Suppress an Email Channel	POST /api/channels/email/suppress
Email Tags	POST /api/channels/email/tags
Uninstall Email Channel	POST /api/channels/email/uninstall
Remove Suppression from an Email Channel	POST /api/channels/email/unsuppress
Look Up an Email Address	GET /api/channels/email/{email}
Update an Email Channel	PUT /api/channels/email/{email}
Register SMS Channel	POST /api/channels/sms
Opt-out of SMS messages	POST /api/channels/sms/opt-out
SMS Tags	POST /api/channels/sms/tags
Uninstall SMS Channel	POST /api/channels/sms/uninstall
Update SMS Channel	PUT /api/channels/sms/{channel_id}
SMS Channel Lookup	GET /api/channels/sms/{msisdn}/{sender}

Events

The Events scope includes only the Add Custom Events endpoint: POST /api/custom-events.

Lists

Endpoints included in the Lists scope:

Name and API reference	Endpoint
Subscription Lists Listing	GET /api/subscription_lists
Retrieve (Attributes) Lists	GET /api/attribute-lists
Create Attributes List	POST /api/attribute-lists
Upload Attribute List	PUT /api/attribute-lists/{list_name}/csv
Download (Attributes) List Errors	GET /api/attribute-lists/{list_name}/errors
(Retrieve) All (Static) Lists	GET /api/lists
Create (Static) List	POST /api/lists
Get Single (Static) List Metadata	GET /api/lists/{list_name}
Update (Static) List Metadata	PUT /api/lists/{list_name}
Delete a (Static) List	DELETE /api/lists/{list_name}
Download a List of Channels (from a Static List)	GET /api/lists/{list_name}/csv
Update (Static) List Contents	PUT /api/lists/{list_name}/csv
Retrieve (Tag) Lists	GET /api/tag-lists
Delete Tag List	DELETE /api/tag-lists/{list_name}
Create a Tag List	POST /api/tag-lists
Upload Tag List	PUT /api/tag-lists/{list_name}/csv
Download (Tag) List Errors	GET /api/tag-lists/{list_name}/errors

Named Users

Endpoints included in the Named Users scope:

Name and API reference	Endpoint
Named User Listing or Lookup	GET /api/named_users
Named Users Association	POST /api/named_users/associate
Named Users Disassociation	POST /api/named_users/disassociate
Scoped Named User Batch Operations	POST /api/named_users/scoped/{named_user_id}
Named Users Tags	POST /api/named_users/tags
Named Users Uninstall	POST /api/named_users/uninstall
Named User Update	POST /api/named_users/{named_user_id}
Set or Remove Attributes on Named Users	POST /api/named_users/{named_user_id}/attributes
Named User Subscription Lists Listing	GET /api/subscription_lists/named_users/{named_user_id}

Pipelines

Endpoints included in the Pipelines scope:

Name and API reference	Endpoint
List Existing Pipelines	GET /api/pipelines
Create Pipeline (Automated Message)	POST /api/pipelines
List Pipelines Constraints	GET /api/pipelines/constraints
Update Pipelines Constraints	PUT /api/pipelines/constraints
List Deleted Pipelines	GET /api/pipelines/deleted
List Filtered Pipelines	GET /api/pipelines/filtered
List Pipelines Limits	GET /api/pipelines/limits
Validate Pipeline	POST /api/pipelines/validate
Individual Pipeline Lookup	GET /api/pipelines/{pipeline_id}
Update Pipeline	PUT /api/pipelines/{pipeline_id}
Delete Pipeline	DELETE /api/pipelines/{pipeline_id}

Push

Endpoints included in the Push scope:

Name and API reference	Endpoint
Send a Push	POST /api/push
Validate Push	POST /api/push/validate
Schedule a Notification	POST /api/schedules
Push to Template	POST /api/templates/push
Validate a Template	POST /api/templates/push/validate
Schedule a Templated Push	POST /api/templates/schedules
Create and Send a message	POST /api/create-and-send
Validate Create and Send Payload	POST /api/create-and-send/validate
Schedule a Create and Send message	POST /api/schedules/create-and-send
Create bulk send audience	POST /api/bulk/{platform_name}
Send message with bulk ID	POST /api/bulk-send
Validate message with bulk ID	POST /api/bulk-send/validate
Schedule message with bulk ID	POST /api/schedules/bulk-send

Schedules

Endpoints included in the Schedules scope:

Name and API reference	Endpoint
List Schedules	GET /api/schedules
List a Specific Schedule	GET /api/schedules/{schedule_id}
Update Schedule	PUT /api/schedules/{schedule_id}
Delete Schedule	DELETE /api/schedules/{schedule_id}
Pause a Schedule	POST /api/schedules/{schedule_id}/pause
Resume a Schedule	POST /api/schedules/{schedule_id}/resume