> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Airship

> How to set up the Airship connector, plus the actions that are available.

![Airship](https://stackone-logos.com/api/airship/filled/svg)

v2.0.1[See changelog](https://docs.stackone.com/connectors/airship/changelog.md)

[39 actions](#actions) · 3 auth methods

Marketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Basic Auth · Connector Profile](https://docs.stackone.com/connectors/airship/guides/connector-profile/basic-auth.md)
>
> Uses the App Key and Master Secret of one Airship project, so the connection covers that project only.

> [card] [Bearer Token · Connector Profile](https://docs.stackone.com/connectors/airship/guides/connector-profile/bearer-token.md)
>
> Connect using a project-level Bearer token generated in Airship. The token's access level (Audience Modification or All...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/airship/guides/connector-profile/oauth-2-0.md)
>
> Connect using OAuth 2.0 client credentials scoped to specific permissions (push, pipelines, schedules, segments, lists).

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Basic Auth · Link Account](https://docs.stackone.com/connectors/airship/guides/link-account/basic-auth.md)

> [card] [Bearer Token · Link Account](https://docs.stackone.com/connectors/airship/guides/link-account/bearer-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/airship/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Basic Auth

Bearer Token

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

lst

pln

psh

sch

seg

No scopes found

39 actions

ActionDescriptionRequired scopes

List Attribute Lists`airship_list_attribute_lists`

Retrieve all attribute lists

`lst`

Create Attribute List`airship_create_attribute_list`

Create a new attribute list

`lst`

Upload Attribute List CSV`airship_upload_attribute_list`

Upload CSV data to an attribute list

`lst`

Get Attribute List Errors`airship_get_attribute_list_errors`

Download errors from attribute list processing

`lst`

List Pipelines`airship_list_pipelines`

List all automation pipelines

`pln`

List Deleted Pipelines`airship_list_deleted_pipelines`

List all deleted pipelines

`pln`

List Filtered Pipelines`airship_list_filtered_pipelines`

List pipelines with filter criteria

`pln`

Get Pipelines Limits`airship_get_pipelines_limits`

Get pipeline limits and counts

`pln`

Get Pipelines Constraints`airship_get_pipelines_constraints`

Get cross-pipeline rate limit constraints

`pln`

Create Pipeline`airship_create_pipeline`

Create a new automation pipeline

`pln`

List Segments`airship_list_segments`

List all segments for the application

`seg`

Get Segment`airship_get_segment`

Retrieve a specific segment by ID

`seg`

Create Segment`airship_create_segment`

Create a new audience segment

`seg`

Update Segment`airship_update_segment`

Update an existing segment

`seg`

Delete Segment`airship_delete_segment`

Delete a segment from the application

`seg`

List Static Lists`airship_list_static_lists`

Retrieve all static lists

`lst`

Get Static List`airship_get_static_list`

Retrieve a specific static list by name

`lst`

Create Static List`airship_create_static_list`

Create a new static list

`lst`

Update Static List Metadata`airship_update_static_list_metadata`

Update metadata for a static list

`lst`

Upload Static List CSV`airship_upload_static_list`

Upload CSV content to a static list

`lst`

Download Static List CSV`airship_download_static_list`

Download contents of a static list as CSV

`lst`

Delete Static List`airship_delete_static_list`

Delete a static list

`lst`

List Tag Lists`airship_list_tag_lists`

List all tag lists for the application

`lst`

Create Tag List`airship_create_tag_list`

Create a new tag list

`lst`

Upload Tag List`airship_upload_tag_list`

Upload CSV data to a tag list

`lst`

Delete Tag List`airship_delete_tag_list`

Delete a tag list

`lst`

Get Tag List Errors`airship_get_tag_list_errors`

Download errors from tag list processing

`lst`

List Schedules`airship_list_schedules`

List all scheduled notifications

`sch`

Get Schedule`airship_get_schedule`

Retrieve a specific scheduled notification

`sch`

Create Scheduled Notification`airship_create_schedule`

Schedule a push notification for future delivery

`sch`

Update Scheduled Notification`airship_update_schedule`

Update an existing scheduled notification

`sch`

Delete Scheduled Notification`airship_delete_schedule`

Cancel and delete a scheduled notification

`sch`

Pause Schedule`airship_pause_schedule`

Pause a recurring scheduled notification

`sch`

Resume Schedule`airship_resume_schedule`

Resume a paused scheduled notification

`sch`

List Templates`airship_list_templates`

List all message templates for the application

`psh`

Get Template`airship_get_template`

Retrieve a specific template by ID

`psh`

Create Template`airship_create_template`

Create a new message template

`psh`

Update Template`airship_update_template`

Update an existing message template

`psh`

Delete Template`airship_delete_template`

Delete a message template

`psh`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.