> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Airship

The Airship connector lets your AI agent act in each user's Airship account. Each user connects their own Airship API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 62 tools.

**Authentication:** API Key
**Categories:** Communication, Marketing
**Tools:** 62: 25 read, 29 write, 8 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=AIRSHIP)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Airship connection

   In **AgentKit > Connections**, create an Airship connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'airship'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Airship:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'airship_channels_list',
     toolInput: { app_key: 'YOUR_APP_KEY' },
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "airship"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Airship:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={"app_key":"YOUR_APP_KEY"},
       tool_name="airship_channels_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Airship credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'airship_channel_get',
  toolInput: {
    app_key: '<app_key>',
    channel_id: '<channel_id>',
  },
  connector: 'airship',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="airship_channel_get",
    tool_input={
        "app_key": "<app_key>",
        "channel_id": "<channel_id>",
    },
    connection_name="airship",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `airship_channel_get`

Channel lookup · Read-only

Fetch an individual channel registered to the app key, along with associated data and metadata.
Returns an object with channel, ok.
Use this when you have the ID. Use airship_channels_list to find one.
Needs channel_id from airship_channels_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `channel_id` (`string`, required): The unique channel identifier. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5

Example input: `{"app_key":"<app_key>","channel_id":"<channel_id>"}`

### `airship_channels_list`

Channel listing · Read-only

List all channels registered to this app key, along with associated data and metadata.
Returns channels, an array of items with address, attributes, background, channel_id, commercial_opted_in, commercial_opted_out, created, device_attributes, device_type, email_address, plus next_page, ok.
Use this to browse. Use airship_channel_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `limit` (`integer`, optional): The default limit is 1,000 channel objects returned per request. Set the limit to 1,000 or fewer in your API calls. Example: 10

Example input: `{"app_key":"<app_key>"}`

### `airship_contact_id_by_channel_get`

Look Up Contact ID by Channel · Read-only

Look up a contact ID for the given channel ID.
Returns an object with contact_id, is_anonymous, ok.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `channel_id` (`string`, required): The channel ID for which to retrieve the associated contact ID. Example: 3f1c2b9e-6a4d-4e1b-9c2a-7d8e5f4a1b2c

Example input: `{"app_key":"<app_key>","channel_id":"<channel_id>"}`

### `airship_contact_id_by_named_user_get`

Look Up Contact ID by Named User · Read-only

Look up a contact ID for the given named user ID.
Returns an object with contact_id, ok.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `named_user_id` (`string`, required): The URL-encoded named user ID for which to retrieve the associated contact ID. Example: user-123

Example input: `{"app_key":"<app_key>","named_user_id":"<named_user_id>"}`

### `airship_create_and_send_validate`

Validate Create and Send Message · Read-only

Validate a create-and-send payload without registering channels or sending.
Returns ok true when Airship would accept the payload.
Use this before airship_create_and_send. It sends nothing.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `audience` (`object`, required): Who receives the message. For create and send, list the addresses to register and message under create_and_send, each with ua_address and opt-in timestamps. Example: {"create_and_send": [{"ua_address": "jane@example.com", "ua_commercial_opted_in": "2026-01-15T09:30:00"}]}
- `device_types` (`array`, required): The platform you want to send notifications to. Example: ["email"]
- `notification` (`object`, required): An `alert` notification or a platform override matching the value in `device types`. A notification with a platform override that does not match your `device_types` will result in a 400 error. Example: {"email": {"subject": "Your order shipped", "html_body": "Order A-1001 shipped.
", "plaintext_body": "Order A-1001 shipped.", "message_type": "transactional", "sender_name": "Acme", "sender_address": "orders@acme.example", "reply_to": "support@acme.example"}}
- `campaigns` (`object`, optional): An object specifying custom campaign categories related to the notification. Example: {"categories": ["winter sale", "west coast"]}

Example input: `{"app_key":"<app_key>","audience":{"tag":"vip"},"device_types":["email"],"notification":{"alert":"Your order A-1001 shipped."}}`

### `airship_email_channel_get`

Look up an email address · Read-only

Return a channel by email address. For security, email addresses are one-way hashed and aren't returned when you look up a channel by ID.
Returns an object with channel, ok.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `email` (`string`, required): The email address of the channel you want to look up. Example: jane@example.com

Example input: `{"app_key":"<app_key>","email":"<email>"}`

### `airship_named_user_subscription_lists_get`

Named user subscription lists listing · Read-only

Named user subscription lists listing. Provides the subscription lists that are associated with a given named user.
Returns an object with ok, subscription_lists.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `named_user_id` (`string`, required): The named user being looked up. Example: user-123

Example input: `{"app_key":"<app_key>","named_user_id":"<named_user_id>"}`

### `airship_named_users_list`

List or Look Up Named Users · Read-only

Return a list of named users or look up a single named user by `named_user_id`.
Returns an object with named_user, ok, named_users, next_page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `id` (`string`, optional): The `named_user_id` you want to look up. When querying a `named_user_id`, the response contains a single `named_user` object. If you do not query a specific `named_user_id`, the response returns an array of `named_users`, in which each object represents an individual named user. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5

Example input: `{"app_key":"<app_key>"}`

### `airship_pipeline_get`

Individual pipeline lookup · Read-only

Fetch a single pipeline resource. Returns an array containing a single pipeline object in the `pipeline` attribute.
Returns an object with next_page, ok, operation_id, pipeline_ids, pipeline_urls, pipelines, prev_page, total_count.
Use this when you have the ID. Use airship_pipelines_list to find one.
Needs pipeline_id from airship_pipelines_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `pipeline_id` (`string`, required): The pipeline you want to return or modify. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5

Example input: `{"app_key":"<app_key>","pipeline_id":"<pipeline_id>"}`

### `airship_pipelines_list`

List existing pipelines · Read-only

List existing pipelines. Pipelines are ordered by `creation_date` from newest to oldest.
Returns an object with next_page, ok, operation_id, pipeline_ids, pipeline_urls, pipelines, prev_page, total_count.
Use this to browse. Use airship_pipeline_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `enabled` (`boolean`, optional): If true, limits the listing to enabled pipelines (`"enabled": true`). If false or omitted, lists all pipelines, whether `enabled` is `true` or `false`. Example: true
- `limit` (`integer`, optional): The maximum number of results to return. This is effectively the page size for the response. No default limit. For maximum performance, set your limit between 25 and 100. Example: 20
- `offset` (`integer`, optional): The first result you want to return. This parameter assists in pagination. Example: 1

Example input: `{"app_key":"<app_key>"}`

### `airship_push_validate`

Validate Push · Read-only

Validate a push payload without sending it.
Returns ok true when Airship would accept the payload, or an error describing what is wrong.
Use this before airship_push_send. It sends nothing.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `audience` (`object`, required): An audience selector forms the expression that determines the set of channels to target. Example: {"tag": "vip"}
- `device_types` (`array`, required): An array containing one or more strings identifying targeted platforms. Example: ["ios", "android"]
- `campaigns` (`object`, optional): An object specifying custom campaign categories related to the notification. Example: {"categories": ["shoes", "running", "summer 2017"]}
- `feed_references` (`object`, optional): 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`. Example: {"feeds": [{"name": "Scalekit test"}]}
- `global_attributes` (`object`, optional): 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 prefix ``ua_``. If the global attributes object is nonempty, it implies the ``personalization: true`` option. Example: {"order_id": "A-1001"}
- `in_app` (`object`, optional): A JSON object describing an in-app message payload. Example: {"alert": "Your order shipped", "display_type": "banner"}
- `localizations` (`array`, optional): An array of localizations. Channels bearing the specified language/country combination will receive the corresponding message. Example: [{"language": "es", "notification": {"alert": "Tu pedido fue enviado."}}]
- `message` (`object`, optional): A Message Center message to deliver along with (or instead of) the notification: title, body (HTML or text) and content_type. Example: {"title": "Order update", "body": "Order A-1001 shipped.
", "content_type": "text/html"}
- `message_type` (`string`, optional): Indicates the purpose of a message. Example: transactional. One of: `transactional`, `commercial`.
- `notification` (`object`, optional): 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. Example: {"alert": "Your order A-1001 shipped."}
- `options` (`object`, optional): A JSON dictionary for specifying non-payload options related to the delivery of the push. Example: {"no_throttle": true, "personalization": true}
- `orchestration` (`object`, optional): 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`. Example: {"type": "channel_priority"}
- `snippet_references` (`object`, optional): 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 to see how to create a snippet in the Airship dashboard. Example: {"snippets": [{"name": "Scalekit test"}]}

Example input: `{"app_key":"<app_key>","audience":{"tag":"vip"},"device_types":["ios","android"]}`

### `airship_report_devices_get`

Get Devices Report · Read-only

Get an app's opted-in and installed device counts by device type.
Returns an object with counts, date_closed, date_computed, total_unique_devices.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `date` (`string`, required): All device events counted occurred before this date-time. Example: 2021-02-28T00:00:00

Example input: `{"app_key":"<app_key>","date":"<date>"}`

### `airship_report_optins_get`

Get Opt-In Report · Read-only

Get the number of opted-in Push users who access the app within the specified time period.
Returns an object with next_page, optins.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `end` (`string`, required): A date-time for end of report. Example: 2021-02-28T00:00:00
- `precision` (`string`, required): Granularity of results to return. Defaults to `DAILY`. Example: DAILY. One of: `HOURLY`, `DAILY`, `MONTHLY`.
- `start` (`string`, required): A date-time for start of report. Example: 2021-02-01T00:00:00

Example input: `{"app_key":"<app_key>","end":"<end>","precision":"HOURLY","start":"<start>"}`

### `airship_report_push_detail_get`

Get Per-Push Detail Report · Read-only

Return statistics and other information for a given push message.
Returns an object with push_id, alerting_sends, app_key, created, direct_responses, influenced_responses, platforms, rich_deletions, rich_responses, rich_sends, sends, silent_sends.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `push_id` (`string`, required): The `push_id` of the requested report. Example: 3f1c2b9e-6a4d-4e1b-9c2a-7d8e5f4a1b2c

Example input: `{"app_key":"<app_key>","push_id":"<push_id>"}`

### `airship_report_push_responses_get`

Get Push Response Statistics · Read-only

Return detailed reports information about a specific push notification.
Returns an object with direct_responses, open_channels_sends, push_time, push_type, push_uuid, sends.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `push_id` (`string`, required): The UUID for the requested push. Example: 90f28bc6-6c9b-4c99-b970-973afc266e08

Example input: `{"app_key":"<app_key>","push_id":"<push_id>"}`

### `airship_report_responses_list`

List Push Responses · Read-only

Get a listing of all pushes, plus basic response information, for a given time period.
Returns an object with next_page, pushes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `end` (`string`, required): A date-time for end of report. Example: 2021-02-28T00:00:00
- `start` (`string`, required): A date-time for start of report. Example: 2021-02-01T00:00:00
- `limit` (`integer`, optional): Number of results to return at one time (for pagination). Example: 10

Example input: `{"app_key":"<app_key>","end":"<end>","start":"<start>"}`

### `airship_report_sends_get`

Get Push Report · Read-only

Get the number of pushes you have sent within a specified time period.
Returns an object with next_page, sends.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `end` (`string`, required): A date-time for end of report. Example: 2021-02-28T00:00:00
- `precision` (`string`, required): Granularity of results to return. Defaults to `DAILY`. Example: DAILY. One of: `HOURLY`, `DAILY`, `MONTHLY`.
- `start` (`string`, required): A date-time for start of report. Example: 2021-02-01T00:00:00

Example input: `{"app_key":"<app_key>","end":"<end>","precision":"HOURLY","start":"<start>"}`

### `airship_schedule_get`

List a specific schedule · Read-only

Fetch the current definition of a single schedule resource.
Returns an object with localization_ids, name, push, push_ids, schedule, url.
Use this when you have the ID. Use airship_schedules_list to find one.
Needs schedule_id from airship_schedules_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `schedule_id` (`string`, required): The ID of a schedule. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5

Example input: `{"app_key":"<app_key>","schedule_id":"<schedule_id>"}`

### `airship_schedules_list`

List schedules · Read-only

List all existing schedules. Returns an array of schedule objects in the `schedules` attribute.
Returns an object with count, next_page, ok, schedules, total_count.
Use this to browse. Use airship_schedule_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `limit` (`integer`, optional): An optional integer as maximum number of elements to return. The default limit is 200 Schedule Objects per request. Set the limit to 200 or fewer in your API calls. Example: 20
- `start` (`string`, optional): An optional string ID of the starting element for paginating results. Example: 8bcb15a6-1f81-451a-95a1-05afd40e271c

Example input: `{"app_key":"<app_key>"}`

### `airship_segment_get`

Segment lookup · Read-only

Lookup a segment.
Returns an object with criteria, display_name.
Use this when you have the ID. Use airship_segments_list to find one.
Needs segment_id from airship_segments_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `segment_id` (`string`, required): The segment you want to retrieve. Example: Active Users

Example input: `{"app_key":"<app_key>","segment_id":"<segment_id>"}`

### `airship_segments_list`

Segment listing · Read-only

List all segments for the application.
Returns segments, an array of items with creation_date, display_name, id, modification_date, plus next_page.
Use this to browse. Use airship_segment_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `limit` (`integer`, optional): Set the limit to 200 or fewer segment objects per request. Example: 10

Example input: `{"app_key":"<app_key>"}`

### `airship_sms_channel_get`

SMS channel lookup · Read-only

Lookup an SMS channel by `msisdn` and `sender`.
Returns an object with channel, ok.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `msisdn` (`integer`, required): The mobile phone number you want to look up a channel for. 15 digits maximum; may not contain leading zeroes. Example: 14155550123
- `sender` (`integer`, required): A long or short code the app is configured to send from. Example: 12345

Example input: `{"app_key":"<app_key>","msisdn":14155550123,"sender":12345}`

### `airship_static_list_get`

Get single list metadata · Read-only

Retrieve information about one static list, specified in the URL.
Returns an object with description, extra, name, ok.
Use this when you have the ID. Use airship_static_lists_list to find one.
Needs list_name from airship_static_lists_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `list_name` (`string`, required): The name of the list. Example: vip_customers

Example input: `{"app_key":"<app_key>","list_name":"<list_name>"}`

### `airship_static_lists_list`

Retrieve lists · Read-only

Retrieve information about all static lists. This call returns a list of metadata that will not contain the actual lists of users.
Returns an object with lists, ok.
Use this to browse. Use airship_static_list_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.

Example input: `{"app_key":"<app_key>"}`

### `airship_subscription_lists_list`

Subscription lists listing · Read-only

Subscription lists listing. Provides a list of subscription lists IDs that are associated with this app key.
Returns an object with ok, subscription_lists.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.

Example input: `{"app_key":"<app_key>"}`

### `airship_channel_attributes_update`

Set or remove attributes on channels · Write

Set or remove attributes on a channel. Aside from Airship's default attributes, you must define attributes in the Airship dashboard before you can set them on channels.
Returns an object with ok, warning.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `attributes` (`array`, required): The attributes to set on or remove from the audience's channels. Each item has an action (set or remove) and a key; set also needs a value. Example: [{"action": "set", "key": "first_name", "value": "Jane"}, {"action": "remove", "key": "nickname"}]
- `audience` (`object`, required): The channel(s) you want to set or remove attributes for. Example: {"email_address": ["jane@example.com"]}

Example input: `{"app_key":"<app_key>","attributes":[{"action":"set","key":"first_name","value":"Jane"},{"action":"remove","key":"nickname"}],"audience":{"email_address":["jane@example.com"]}}`

### `airship_channel_subscription_lists_update`

Update Channel Subscription Lists · Write

Subscribe or unsubscribe channels to/from subscription lists.
Returns an object with ok, operation_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `audience` (`object`, required): The channels to change, for example {"ios_channel": ""} or {"email_address": "jane@example.com"}.
- `subscription_lists` (`array`, required): The subscription list changes. Each item has an action (subscribe or unsubscribe) and a list_id. Example: [{"action": "subscribe", "list_id": "weekly_news"}]

Example input: `{"app_key":"<app_key>","audience":{"tag":"vip"},"subscription_lists":[{"action":"subscribe","list_id":"weekly_news"}]}`

### `airship_channel_tags_update`

Channel tags · Write

Channel tags. Add, remove, or set tags on a channel.
Returns an object with ok, warnings.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `audience` (`object`, required): Specifies one or more channels that you want to apply tag operations to. Example: {"tag": "vip"}
- `add` (`object`, optional): Adds the specified tags to the channel. Tags that are already present are not modified/removed as a result of this operation. Example: {"loyalty": ["gold"]}
- `remove` (`object`, optional): Removes the specified tags from the channel. Example: {"loyalty": ["silver"]}
- `set` (`object`, optional): Assigns a list of tags exactly. Any previously set tags that are not in this current list will be removed. Example: {"loyalty": ["gold"]}

Example input: `{"app_key":"<app_key>","audience":{"tag":"vip"}}`

### `airship_create_and_send`

Create and Send Message · Write

Register email, SMS, MMS or open-channel addresses and send them a message in one call.
Returns ok, operation_id and push_ids.
Use this when the recipients are addresses rather than existing channels. Use airship_push_send for app and web push to existing audiences. Run airship_create_and_send_validate first to check a payload.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `audience` (`object`, required): Who receives the message. For create and send, list the addresses to register and message under create_and_send, each with ua_address and opt-in timestamps. Example: {"create_and_send": [{"ua_address": "jane@example.com", "ua_commercial_opted_in": "2026-01-15T09:30:00"}]}
- `device_types` (`array`, required): The platform you want to send notifications to. Example: ["email"]
- `notification` (`object`, required): An `alert` notification or a platform override matching the value in `device types`. A notification with a platform override that does not match your `device_types` will result in a 400 error. Example: {"email": {"subject": "Your order shipped", "html_body": "Order A-1001 shipped.
", "plaintext_body": "Order A-1001 shipped.", "message_type": "transactional", "sender_name": "Acme", "sender_address": "orders@acme.example", "reply_to": "support@acme.example"}}
- `campaigns` (`object`, optional): An object specifying custom campaign categories related to the notification. Example: {"categories": ["winter sale", "west coast"]}

Example input: `{"app_key":"<app_key>","audience":{"tag":"vip"},"device_types":["email"],"notification":{"alert":"Your order A-1001 shipped."}}`

### `airship_custom_events_create`

Add custom events · Write

Submit an externally-generated custom event, associated with a channel ID or named user, to Airship.
Returns an object with ok, operation_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `body` (`array`, required): An array of custom event objects. Example: [{"user": {"named_user_id": "tommy_tutone", "amazon_channel": "3c070fc0-e976-4563-b088-ec8946176a01"}, "body": {"name": "purchased"}}]

Example input: `{"app_key":"<app_key>","body":[{"user":{"named_user_id":"tommy_tutone","amazon_channel":"3c070fc0-e976-4563-b088-ec8946176a01"},"body":{"name":"purchased"}}]}`

### `airship_email_channel_register`

Register email channel · Write

Create a new email channel or update an existing channel.
Returns an object with attributes, channel_id, ok, tags.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `channel` (`object`, required): The email channel: type (email), address, and the commercial/transactional opt-in or opt-out timestamps, plus optional locale and timezone. Example: {"type": "email", "address": "jane@example.com", "commercial_opted_in": "2026-01-15T09:30:00"}
- `attributes` (`array`, optional): The attributes to set or remove. Each item has an action (set or remove) and a key; set also needs a value. Example: [{"action": "set", "key": "first_name", "value": "Jane"}, {"action": "remove", "key": "nickname"}]
- `opt_in_mode` (`string`, optional): The opt-in mode for registering the channel. `classic` is the default when unspecified, `double` creates a `double_opt_in` event. Example: double. One of: `classic`, `double`.
- `properties` (`object`, optional): An object containing event properties. You can use these properties to filter the double opt-in event and reference them in your message content by using handlebars. Items in the `properties` object are limited to a 255-character maximum string length. Example: {"interests": "newsletter"}
- `tag_operations` (`object`, optional): Optionally one or more tag group objects associated with the email. Example: {"loyalty": ["gold"]}

Example input: `{"app_key":"<app_key>","channel":{"type":"email","address":"jane@example.com","commercial_opted_in":"2026-01-15T09:30:00"}}`

### `airship_email_channel_suppress`

Suppress an email channel · Write

Suppress an email channel. Suppress an existing email channel, disallowing any future delivery from being fulfilled for the channel.
Returns an object with ok, operation_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `address` (`string`, required): The email address for the channel to be suppressed. Example: user@example.com
- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `reason` (`string`, required): The reason for suppressing the channel. If there is no specific reason, use `imported`. Example: spam_complaint. One of: `spam_complaint`, `commercial_spam_complaint`, `bounce`, `imported`.

Example input: `{"address":"<address>","app_key":"<app_key>","reason":"spam_complaint"}`

### `airship_email_channel_tags_update`

Email tags · Write

Email tags. Add, remove, or set tags for a single email channel.
Returns an object with ok, operation_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `audience` (`object`, required): Specifies the email address you want to perform tag operations against. Must contain a single `email_address` key. Example: {"email_address": "jane@example.com"}
- `add` (`object`, optional): Adds the specified tags to the channel. Tags that are already present are not modified/removed as a result of this operation. Example: {"loyalty": ["gold"]}
- `remove` (`object`, optional): Removes the specified tags from the channel. Example: {"loyalty": ["silver"]}
- `set` (`object`, optional): Assigns a list of tags exactly. Any previously set tags that are not in this current list are removed. Example: {"loyalty": ["gold"]}

Example input: `{"app_key":"<app_key>","audience":{"email_address":"jane@example.com"}}`

### `airship_email_channel_update`

Update an email channel · Write

Update an email channel's opt-in and opt-out values for commercial email, transactional email, and open and click tracking.
Returns the JSON response from Airship.
The request replaces the stored value with what you send.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `channel` (`object`, required): The email channel: type (email), address, and the commercial/transactional opt-in or opt-out timestamps, plus optional locale and timezone. Example: {"type": "email", "address": "jane@example.com", "commercial_opted_in": "2026-01-15T09:30:00"}
- `email` (`string`, required): The email `channel_id` you want to modify. Example: jane@example.com

Example input: `{"app_key":"<app_key>","channel":{"type":"email","address":"jane@example.com","commercial_opted_in":"2026-01-15T09:30:00"},"email":"<email>"}`

### `airship_named_user_associate`

Associate Named User · Write

Associate a channel or email address with a named user (`named_user_id`).
Returns an object with ok, operation_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `named_user_id` (`string`, required): A string value identifying the user, without leading or trailing whitespace. Example: user-123
- `channel_id` (`string`, optional): The channel ID you want to associate with a named user. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5
- `device_type` (`string`, optional): The device type of the channel. Example: ios. One of: `ios`, `android`, `amazon`, `web`, `open`, `email`, `sms`.
- `email_address` (`string`, optional): The email address you want to associate with a named user. Example: user@example.com

Example input: `{"app_key":"<app_key>","named_user_id":"<named_user_id>"}`

### `airship_named_user_attributes_update`

Set or remove attributes on named users · Write

Set or remove attributes on a named user. A single request body may contain a `set` or `remove` field, or both, or a single `set` field.
Returns an object with ok, warnings.
Needs named_user_id from airship_named_users_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `attributes` (`array`, required): The attributes to set on or remove from the named user. Each item has an action (set or remove) and a key; set also needs a value and may carry a timestamp. Example: [{"action": "set", "key": "first_name", "value": "Jane"}]
- `named_user_id` (`string`, required): The named user you are setting the attributes for. Example: user-123

Example input: `{"app_key":"<app_key>","attributes":[{"action":"set","key":"first_name","value":"Jane"}],"named_user_id":"<named_user_id>"}`

### `airship_named_user_disassociate`

Disassociate Named User · Write

Disassociate a channel or an email address from a `named_user_id`.
Returns an object with ok, operation_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `channel_id` (`string`, optional): The channel ID you want to disassociate from a named user. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5
- `device_type` (`string`, optional): The device type of the channel. Example: ios. One of: `ios`, `android`, `amazon`, `web`, `email`, `sms`, `open`.
- `email_address` (`string`, optional): The email address you want to disassociate from a named user. Example: user@example.com
- `named_user_id` (`string`, optional): The existing named user ID. Example: user-123

Example input: `{"app_key":"<app_key>"}`

### `airship_named_user_tags_update`

Named users tags · Write

Named users tags. Add, remove, or set tags on a named user. A single request body may contain add and/or remove objects or a single set field.
Returns an object with ok, tag_warnings.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `audience` (`object`, required): The named user(s) you want to associate/disassociate tags with. Example: {"tag": "vip"}
- `add` (`object`, optional): Add the list of tags to the named user(s), but do not remove any. If the tags are already present, they are not modified. Example: {"loyalty": ["gold"]}
- `remove` (`object`, optional): Remove the list of tags from the named user(s), but do not remove any others. If the tags are not currently present, nothing happens. Example: {"loyalty": ["silver"]}
- `set` (`object`, optional): Set these tags for the audience; any tags previously associated with the audience tags that are not in this current list are removed. Example: {"loyalty": ["gold"]}

Example input: `{"app_key":"<app_key>","audience":{"tag":"vip"}}`

### `airship_named_user_update`

Named user update · Write

Create or update a named user by associating/disassociating channels and adding/removing tags and attributes in a single request.
Returns an object with attribute_warnings, ok, tag_warnings.
Needs named_user_id from airship_named_users_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `named_user_id` (`string`, required): A string value identifying the user, without leading or trailing whitespace. If this value contains reserved or special characters they must be URL encoded. Example: user-123
- `associate` (`array`, optional): Associate a list of channels or email addresses with the named user. If the `channel_id` or `email_address` is already associated with the named user, this operation will do nothing. Example: [{"email_address": "jane@example.com"}]
- `attributes` (`array`, optional): The attributes to set or remove. Each item has an action (set or remove) and a key; set also needs a value. Example: [{"action": "set", "key": "first_name", "value": "Jane"}, {"action": "remove", "key": "nickname"}]
- `disassociate` (`array`, optional): Disassociate a channel or an email address from the named user. Example: [{"channel_id": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5", "device_type": "ios"}]
- `tags` (`object`, optional): Add, remove, or set tags on a named user. A single request body may contain add and/or remove objects or a single set field. At least one of the add, remove, or set objects must be present in a request. A tag must be < 128 characters. A request with one or more tags longer than 128 characters will return a 400 response. If at least one of the tags included in the request is valid, i.e., at least one tags exists, Airship returns a 200 with a warning containing a list of tags that failed to update. Example: {"add": {"loyalty": ["gold"]}}

Example input: `{"app_key":"<app_key>","named_user_id":"<named_user_id>"}`

### `airship_open_channel_upsert`

Register or Update Open Channel · Write

Create a new open channel or update an existing open channel.
Returns an object with channel_id, ok.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `channel` (`object`, required): Properties of the open channel object. Example: {"address": "Number Four", "locale_country": "US", "locale_language": "en", "open": {"identifiers": {"model": "4"}, "open_platform_name": "cylon"}, "opt_in": true, "tags": ["toaster", "caprica"], "timezone": "America/Los_Angeles", "type": "open"}

Example input: `{"app_key":"<app_key>","channel":{"type":"email","address":"jane@example.com","commercial_opted_in":"2026-01-15T09:30:00"}}`

### `airship_pipeline_create`

Create Pipeline · Write

Create one or more pipelines. You can provide a single pipeline object or an array of pipeline objects.
Returns an object with ok, operation_id, pipeline_urls.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `enabled` (`boolean`, required): A boolean value indicating whether or not the pipeline is active. Example: true
- `outcome` (`array`, required): What the pipeline sends when it fires: a push object (audience triggered, device_types and notification) and an optional delay. Example: {"push": {"audience": "triggered", "device_types": ["ios", "android"], "notification": {"alert": "Hello Early Bird"}}}
- `activation_time` (`string`, optional): The date-time when the pipeline becomes active and begins processing triggers and issuing push notifications. If this value is in the future, the pipeline's `status` is `pending`. Example: 2026-01-15T09:30:00Z
- `cancellation_trigger` (`array`, optional): An event that cancels pending sends from this pipeline, such as open (the app was opened) or a tag or custom event trigger. Example: open
- `condition` (`array`, optional): One or more conditions, combined by operators. A condition set may contain a maximum of 20 conditions. Taken together, the operator and set of conditions form a boolean expression which must evaluate to true for a pipeline to be activated and its outcomes executed. Valid operators for a condition set are `and` and `or`. Nesting of operators is not supported within a condition set, i.e., you may not combine `and` logic with `or` logic. Example: [{"and": [{"subscription": {"list_name": "Scalekit test"}, "tag": {"tag_name": "Scalekit test"}}], "or": [{"subscription": {"list_name": "Scalekit test"}, "tag": {"tag_name": "Scalekit test"}}]}]
- `constraint` (`array`, optional): An array of rate objects determining the maximum number of messages each audience member can receive over a period of time. You can set a `lifetimes` constraint as well, limiting a pipeline to an absolute maximum number of messages ever. Example: [{"rate": {"days": 10, "pushes": 10}}]
- `deactivation_time` (`string`, optional): The date-time when the pipeline becomes inactive and quits processing triggers and issuing push notifications. If this value is in the past, the pipeline's `status` is `completed`. Example: 2026-01-15T09:30:00Z
- `historical_trigger` (`array`, optional): Triggers on past behaviour, for example a channel that has not opened the app for a number of days (days and creation_time).
- `immediate_trigger` (`array`, optional): The event that fires the pipeline right away, such as tag_added, tag_removed, first_open or a custom_event. Example: {"tag_added": {"tag": "earlyBirds"}}
- `name` (`string`, optional): A descriptive name for the pipeline. Example: VIP customers
- `timing` (`object`, optional): Determines when pipelines will be sent in accordance with triggers. Example: {"delay": {"seconds": 60}}

Example input: `{"app_key":"<app_key>","enabled":true,"outcome":[]}`

### `airship_pipeline_update`

Update pipeline · Write

Update the state of a single pipeline resource. You must include the complete payload from a POST response, with changes you want to make to the resource.
Returns an object with ok, operation_id.
The request replaces the stored value with what you send.
Needs pipeline_id from airship_pipelines_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `enabled` (`boolean`, required): A boolean value indicating whether or not the pipeline is active. Example: true
- `outcome` (`array`, required): What the pipeline sends when it fires: a push object (audience triggered, device_types and notification) and an optional delay. Example: {"push": {"audience": "triggered", "device_types": ["ios", "android"], "notification": {"alert": "Greetings Early Bird"}}}
- `pipeline_id` (`string`, required): The pipeline you want to return or modify. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5
- `activation_time` (`string`, optional): The date-time when the pipeline becomes active and begins processing triggers and issuing push notifications. If this value is in the future, the pipeline's `status` is `pending`. Example: 2026-01-15T09:30:00Z
- `cancellation_trigger` (`array`, optional): An event that cancels pending sends from this pipeline, such as open (the app was opened) or a tag or custom event trigger. Example: open
- `condition` (`array`, optional): One or more conditions, combined by operators. A condition set may contain a maximum of 20 conditions. Taken together, the operator and set of conditions form a boolean expression which must evaluate to true for a pipeline to be activated and its outcomes executed. Valid operators for a condition set are `and` and `or`. Nesting of operators is not supported within a condition set, i.e., you may not combine `and` logic with `or` logic. Example: [{"and": [{"subscription": {"list_name": "Scalekit test"}, "tag": {"tag_name": "Scalekit test"}}], "or": [{"subscription": {"list_name": "Scalekit test"}, "tag": {"tag_name": "Scalekit test"}}]}]
- `constraint` (`array`, optional): An array of rate objects determining the maximum number of messages each audience member can receive over a period of time. You can set a `lifetimes` constraint as well, limiting a pipeline to an absolute maximum number of messages ever. Example: [{"rate": {"days": 10, "pushes": 10}}]
- `deactivation_time` (`string`, optional): The date-time when the pipeline becomes inactive and quits processing triggers and issuing push notifications. If this value is in the past, the pipeline's `status` is `completed`. Example: 2026-01-15T09:30:00Z
- `historical_trigger` (`array`, optional): Triggers on past behaviour, for example a channel that has not opened the app for a number of days (days and creation_time).
- `immediate_trigger` (`array`, optional): The event that fires the pipeline right away, such as tag_added, tag_removed, first_open or a custom_event. Example: {"tag_added": {"tag": "earlyBirds"}}
- `name` (`string`, optional): A descriptive name for the pipeline. Example: VIP customers
- `timing` (`object`, optional): Determines when pipelines will be sent in accordance with triggers. Example: {"delay": {"seconds": 60}}

Example input: `{"app_key":"<app_key>","enabled":true,"outcome":[],"pipeline_id":"<pipeline_id>"}`

### `airship_push_send`

Send Push · Write

Send a push, in-app or Message Center message to an Airship audience (all, a tag, a named user, a channel or a segment) on the device types you choose.
Returns ok, operation_id and push_ids (one per message sent).
Use this for app and web push. Use airship_create_and_send for email, SMS, MMS or open channels to addresses not yet registered, and airship_schedule_create to send later. Run airship_push_validate first to check a payload without sending.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `audience` (`object`, required): An audience selector forms the expression that determines the set of channels to target. Example: {"tag": "vip"}
- `device_types` (`array`, required): An array containing one or more strings identifying targeted platforms. Example: ["ios", "android"]
- `campaigns` (`object`, optional): An object specifying custom campaign categories related to the notification. Example: {"categories": ["shoes", "running", "summer 2017"]}
- `feed_references` (`object`, optional): 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`. Example: {"feeds": [{"name": "Scalekit test"}]}
- `global_attributes` (`object`, optional): 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 prefix ``ua_``. If the global attributes object is nonempty, it implies the ``personalization: true`` option. Example: {"order_id": "A-1001"}
- `in_app` (`object`, optional): A JSON object describing an in-app message payload. Example: {"alert": "Your order shipped", "display_type": "banner"}
- `localizations` (`array`, optional): An array of localizations. Channels bearing the specified language/country combination will receive the corresponding message. Example: [{"language": "es", "notification": {"alert": "Tu pedido fue enviado."}}]
- `message` (`object`, optional): A Message Center message to deliver along with (or instead of) the notification: title, body (HTML or text) and content_type. Example: {"title": "Order update", "body": "Order A-1001 shipped.
", "content_type": "text/html"}
- `message_type` (`string`, optional): Indicates the purpose of a message. Example: transactional. One of: `transactional`, `commercial`.
- `notification` (`object`, optional): 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. Example: {"alert": "Your order A-1001 shipped."}
- `options` (`object`, optional): A JSON dictionary for specifying non-payload options related to the delivery of the push. Example: {"no_throttle": true, "personalization": true}
- `orchestration` (`object`, optional): 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`. Example: {"type": "channel_priority"}
- `snippet_references` (`object`, optional): 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 to see how to create a snippet in the Airship dashboard. Example: {"snippets": [{"name": "Scalekit test"}]}

Example input: `{"app_key":"<app_key>","audience":{"tag":"vip"},"device_types":["ios","android"]}`

### `airship_schedule_create`

Schedule Notification · Write

Schedule a push to go out at a set time, at a local time per device, or at the best time.
Returns ok, operation_id and schedule_urls, schedule_ids and the stored schedules.
Use this to send later. Use airship_push_send to send now and airship_schedule_update to change a scheduled send.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `push` (`object`, required): 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. Example: {"audience": {"tag": "vip"}, "device_types": ["ios", "android"], "notification": {"alert": "Your order A-1001 shipped."}}
- `schedule` (`object`, required): When to send: scheduled_time (UTC, YYYY-MM-DDTHH:MM:SS), local_scheduled_time (each device's local time), or best_time. Example: {"scheduled_time": "2026-12-01T15:00:00"}
- `localization_ids` (`array`, optional): An array of identifiers used for reporting. Each ID represents a localized message (push object with `localizations` array). Example: ["3f1c2b9e-6a4d-4e1b-9c2a-7d8e5f4a1b2c"]
- `name` (`string`, optional): An optional string. Example: VIP customers

Example input: `{"app_key":"<app_key>","push":{},"schedule":{"scheduled_time":"2026-12-01T15:00:00"}}`

### `airship_schedule_pause`

Pause a schedule · Write

Pause a recurring scheduled message, preventing Airship from sending messages on a recurring scheduled message interval.
Returns an empty response on success (HTTP 204).
Needs schedule_id from airship_schedules_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `schedule_id` (`string`, required): The ID of the schedule you want to pause. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5

Example input: `{"app_key":"<app_key>","schedule_id":"<schedule_id>"}`

### `airship_schedule_resume`

Resume a schedule · Write

Resume a recurring schedule that you previously paused, beginning with the next scheduled interval.
Returns an empty response on success (HTTP 204).
Needs schedule_id from airship_schedules_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `schedule_id` (`string`, required): The ID of the schedule you want to resume. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5

Example input: `{"app_key":"<app_key>","schedule_id":"<schedule_id>"}`

### `airship_schedule_update`

Update schedule · Write

Update the state of a single schedule resource. The body must contain a single schedule object.
Returns an object with ok, operation_id, schedule_urls, schedules.
The request replaces the stored value with what you send.
Needs schedule_id from airship_schedules_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `push` (`object`, required): 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. Example: {"audience": {"tag": "vip"}, "device_types": ["ios", "android"], "notification": {"alert": "Your order A-1001 shipped."}}
- `schedule` (`object`, required): When to send: scheduled_time (UTC, YYYY-MM-DDTHH:MM:SS), local_scheduled_time (each device's local time), or best_time. Example: {"scheduled_time": "2026-12-01T15:00:00"}
- `schedule_id` (`string`, required): The ID of a schedule. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5
- `localization_ids` (`array`, optional): An array of identifiers used for reporting. Each ID represents a localized message (push object with `localizations` array). Example: ["3f1c2b9e-6a4d-4e1b-9c2a-7d8e5f4a1b2c"]
- `name` (`string`, optional): An optional string. Example: VIP customers

Example input: `{"app_key":"<app_key>","push":{},"schedule":{"scheduled_time":"2026-12-01T15:00:00"},"schedule_id":"<schedule_id>"}`

### `airship_segment_create`

Create segment · Write

Create a new segment.
Returns an object with ok, operation_id, segment_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `criteria` (`object`, required): Defines the set of devices to send notifications to. `criteria` is a JSON expression containing the same information as the audience selector, including Event Segmentation. See Audience selection for more information. Example: {"tag": "news"}
- `display_name` (`string`, required): Human readable name for this segment. This will be used in the dashboard. Example: VIP customers

Example input: `{"app_key":"<app_key>","criteria":{"tag":"news"},"display_name":"<display_name>"}`

### `airship_segment_update`

Update segment · Write

Change the definition of the segment.
Returns an object with ok, operation_id.
The request replaces the stored value with what you send.
Needs segment_id from airship_segments_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `criteria` (`object`, required): Defines the set of devices to send notifications to. `criteria` is a JSON expression containing the same information as the audience selector, including Event Segmentation. See Audience selection for more information. Example: {"tag": "news"}
- `display_name` (`string`, required): Human readable name for this segment. This will be used in the dashboard. Example: VIP customers
- `segment_id` (`string`, required): The segment you want to retrieve. Example: Active Users

Example input: `{"app_key":"<app_key>","criteria":{"tag":"news"},"display_name":"<display_name>","segment_id":"<segment_id>"}`

### `airship_sms_channel_opt_out`

Opt-out of SMS messages · Write

Opt-out of SMS messages. This will mark an SMS channel as opted-out (inactive) and it will not receive alerts even when they are addressed in the future.
Returns an object with ok.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `msisdn` (`string`, required): The mobile phone number you want to opt-out of SMS messages. Must be numeric characters only, without leading zeros. 15 digits maximum. Example: 14155550123
- `sender` (`string`, required): A long or short code the app is configured to send from. For example, `12345`.

Example input: `{"app_key":"<app_key>","msisdn":"<msisdn>","sender":"<sender>"}`

### `airship_sms_channel_register`

Register SMS channel · Write

Create an SMS channel. If the channel has not opted in yet (the request did not contain `opted_in`), Airship creates the channel with `opt_in` set to `false` and the user receives a message prompting them to complete the opt-in flow; you can assign tags and organize `pending` channels before the use...
Returns an object with attributes, channel_id, ok, operation_id, tags, push_id, status.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `msisdn` (`string`, required): The mobile phone number you want to register as an SMS channel (or send a request to opt-in). Must be numeric characters only, without leading zeros. Example: 14155550123
- `sender` (`string`, required): A long or short code the app is configured to send from. For example, `12345`.
- `attributes` (`array`, optional): The attributes to set or remove. Each item has an action (set or remove) and a key; set also needs a value. Example: [{"action": "set", "key": "first_name", "value": "Jane"}, {"action": "remove", "key": "nickname"}]
- `locale_country` (`string`, optional): The ISO 3166 two-character country code. The value for this field becomes a tag in the `ua_locale_country` tag group. Example: US
- `locale_language` (`string`, optional): The ISO 639-1 two-character language code. The value for this field becomes a tag in the `ua_locale_language` tag group. Example: en
- `opted_in` (`string`, optional): The date-time that represents the date and time when explicit permission was received from the user to receive messages. Example: 2020-02-13T11:58:59
- `tag_operations` (`object`, optional): Optionally one or more tag group objects associated with the SMS channel. Example: {"loyalty": ["gold"]}
- `timezone` (`string`, optional): The IANA identifier for a time zone, e.g., `America/Los_Angeles`. The value in this field becomes a tag in the `timezone` tag group. Example: America/Los_Angeles

Example input: `{"app_key":"<app_key>","msisdn":"<msisdn>","sender":"<sender>"}`

### `airship_sms_channel_update`

Update SMS channel · Write

Update an existing SMS channel to reflect opt-in date, time zone and/or locale changes.
Returns an object with ok, operation_id.
The request replaces the stored value with what you send.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `channel_id` (`string`, required): The identifier for the SMS channel you want to update. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5
- `msisdn` (`string`, required): The phone number corresponding to the `channel_id` in the request. You cannot change this value for the existing channel. Example: 14155550123
- `sender` (`string`, required): The sender corresponding to the `channel_id` in the request. You cannot change this value for an existing channel. Example: 12345
- `locale_country` (`string`, optional): The ISO 3166 two-character country code. The value for this field becomes a tag in the `ua_locale_country` tag group. Example: US
- `locale_language` (`string`, optional): The ISO 639-1 two-character language code. The value for this field becomes a tag in the `ua_locale_language` tag group. Example: en
- `opted_in` (`string`, optional): The date-time that represents when explicit permission was received from the user to receive messages. Example: 2020-02-13T11:58:59
- `timezone` (`string`, optional): The IANA identifier for a time zone, e.g., `America/Los_Angeles`. The value in this field becomes a tag in the `timezone` tag group. Example: America/Los_Angeles

Example input: `{"app_key":"<app_key>","channel_id":"<channel_id>","msisdn":"<msisdn>","sender":"<sender>"}`

### `airship_static_list_create`

Create list · Write

Create a static list. The body of the request will contain several of the list object parameters, but the actual list content will be provided by a second call to the upload endpoint.
Returns an object with ok, operation_id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `name` (`string`, required): The name of the list, consists of up to 64 URL-safe characters. The name is how the list is identified, so it should be unique and memorable. Note: Since the `name` portion of the URL may represent any Unicode string, it must be encoded properly as a URI path component. The `encodeURIComponent` function in JavaScript can be used. Example: vip_customers
- `description` (`string`, optional): An optional description for the list. Example: loyalty program platinum members
- `extra` (`string`, optional): An optional JSON map of up to 100 key-value (string-to-string) pairs associated with the list. Keys in this object have a 64-character maximum; values can be up to 1,024 characters. Example: {"tier": "platinum"}

Example input: `{"app_key":"<app_key>","name":"<name>"}`

### `airship_static_list_update`

Update list metadata · Write

Update the metadata (`description`, `extras`, etc.) of a static list.
Returns an object with ok, operation_id.
The request replaces the stored value with what you send.
Needs list_name from airship_static_lists_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `list_name` (`string`, required): The name of the list. Example: vip_customers
- `name` (`string`, required): The name of the list, consists of up to 64 URL-safe characters. The name is how the list is identified, so it should be unique and memorable. Note: Since the `name` portion of the URL may represent any Unicode string, it must be encoded properly as a URI path component. The `encodeURIComponent` function in JavaScript can be used. Example: vip_customers
- `description` (`string`, optional): An optional description for the list. Example: VIP loyalty program platinum members
- `extra` (`string`, optional): An optional JSON map of up to 100 key-value (string-to-string) pairs associated with the list. Keys in this object have a 64-character maximum; values can be up to 1,024 characters. Example: {"tier": "platinum"}

Example input: `{"app_key":"<app_key>","list_name":"<list_name>","name":"<name>"}`

### `airship_channels_uninstall`

Uninstall Channels · Destructive

Uninstall a channel, removing it and all accompanying analytic data (including Performance Analytics) from Airship systems in accordance with data privacy law compliance.
Returns an object with ok, operation_id.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `body` (`array`, required): Request body. Example: [{"channel_id": "bd36e8c7-5a73-47c0-9716-99fd3d4197d5", "device_type": "ios"}]

Example input: `{"app_key":"<app_key>","body":[{"channel_id":"bd36e8c7-5a73-47c0-9716-99fd3d4197d5","device_type":"ios"}]}`

### `airship_email_channel_uninstall`

Uninstall email channel · Destructive

Remove an email address from Airship. Use with caution.
Returns an object with ok, operation_id.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `email_address` (`string`, required): The email address of the channel to uninstall. Example: name@example.com

Example input: `{"app_key":"<app_key>","email_address":"<email_address>"}`

### `airship_named_users_uninstall`

Named users uninstall · Destructive

Disassociate and delete all channels associated with the named_user_id(s) and also delete the named_user_id(s).
Returns an object with ok, operation_id.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `named_user_id` (`array`, required): Array of strings representing the named_user_id(s) you wish to be uninstalled. Must have between 1 to 100 items in the array with a 128 character/byte maximum per item. Example: ["user-123"]

Example input: `{"app_key":"<app_key>","named_user_id":["user-123"]}`

### `airship_pipeline_delete`

Delete pipeline · Destructive

Delete a pipeline.
Returns an empty response on success (HTTP 204).
Needs pipeline_id from airship_pipelines_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `pipeline_id` (`string`, required): The pipeline you want to return or modify. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5

Example input: `{"app_key":"<app_key>","pipeline_id":"<pipeline_id>"}`

### `airship_schedule_delete`

Delete schedule · Destructive

Delete a schedule resource, which will result in no more pushes being sent.
Returns an empty response on success (HTTP 204).
Needs schedule_id from airship_schedules_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `schedule_id` (`string`, required): The ID of a schedule. Example: 9c36e8c7-5a73-47c0-9716-99fd3d4197d5

Example input: `{"app_key":"<app_key>","schedule_id":"<schedule_id>"}`

### `airship_segment_delete`

Delete segment · Destructive

Remove the segment.
Returns an empty response on success (HTTP 204).
Needs segment_id from airship_segments_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `segment_id` (`string`, required): The segment you want to retrieve. Example: Active Users

Example input: `{"app_key":"<app_key>","segment_id":"<segment_id>"}`

### `airship_sms_channel_uninstall`

Uninstall SMS channel · Destructive

Remove phone numbers and accompanying data from Airship.
Returns an object with ok.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `msisdn` (`string`, required): The mobile phone number you want to remove from the Airship system. Must be numeric characters only, without leading zeros. 15 digits maximum. Example: 14155550123
- `sender` (`string`, required): A long or short code the app is configured to send from. For example, `12345`.

Example input: `{"app_key":"<app_key>","msisdn":"<msisdn>","sender":"<sender>"}`

### `airship_static_list_delete`

Delete a list · Destructive

Delete a static list.
Returns an empty response on success (HTTP 204).
Needs list_name from airship_static_lists_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `app_key` (`string`, required): Your Airship project's app key (22 characters), from Settings > Project configuration > APIs & Integrations in the Airship dashboard. It is sent as the X-UA-Appkey header.
- `list_name` (`string`, required): The name of the list. Example: vip_customers

Example input: `{"app_key":"<app_key>","list_name":"<list_name>"}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
