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

> ## Agent Instructions
> Install the Courier skill before writing code: `npx skills add trycourier/courier-skills`. It carries the verified SDK shapes and the rules you cannot get wrong.
> Authenticate every request with `Authorization: Bearer <API_KEY>`. A workspace has several environments and each has its own keys, which are plain `pk_` strings with no environment prefix. Start with Test.
> Send with `client.send.message` from the Node SDK (`@trycourier/courier` v7 and later, where the client is the default import). Reference a template by its `nt_` id or its alias.
> A send accepts a bare Elemental element list, but storing content on a template requires the top-level elements wrapped in a channel element.
> Templates and journeys can be built in the Courier app or created through the API. Either way they live in the workspace and are referenced by ID when you send.
> The hosted MCP server is https://mcp.courier.com. For a briefing on what Courier is and when to use it, read https://www.courier.com/llms.txt.
> Prefer the Guides tab for how-do-I questions and the Docs tab for how-does-it-behave questions. The API reference lives under /api-reference.

# Send push with Airship through Courier

> Connect Airship with an app key and secret, and target audience and device_types from the profile.

export const Endpoint = ({method, path, name, href, children, bare}) => {
  const verb = String(method || "").toUpperCase();
  const title = verb + " " + path;
  const label = children || name || path;
  if (bare) {
    return href ? <a href={href}><code>{title}</code></a> : <code>{title}</code>;
  }
  if (!href) {
    return <span className="cx-endpoint" data-method={verb} title={title}>
        <span className="cx-endpoint-label">{label}</span>
        <span className="cx-endpoint-method">{verb}</span>
      </span>;
  }
  return <a className="cx-endpoint" data-method={verb} href={href} title={title}>
      <span className="cx-endpoint-label">{label}</span>
      <span className="cx-endpoint-method">{verb}</span>
    </a>;
};

export const AppLink = ({href, children, name, bare}) => {
  const label = children || name || "Open in Courier";
  if (bare) {
    return <a href={href} target="_blank" rel="noreferrer">{label}</a>;
  }
  return <a className="cx-endpoint" data-kind="app" href={href} target="_blank" rel="noreferrer">
      <span className="cx-endpoint-label">{label}</span>
      <span className="cx-endpoint-method" aria-hidden="true">↗</span>
    </a>;
};

export const Doc = ({href, children, name, bare}) => {
  const label = children || name || href;
  if (bare) {
    return <a href={href}>{label}</a>;
  }
  return <a className="cx-endpoint" data-kind="doc" href={href}>
      <span className="cx-endpoint-label">{label}</span>
      <span className="cx-endpoint-method">DOC</span>
    </a>;
};

## Prerequisites

* [An Airship account with a project](https://www.airship.com/)
* Your Airship auth token and base URL

## Setup

<Steps>
  <Step title="Create an Airship auth token">
    In Airship, open your project at [go.airship.com](https://go.airship.com/) and create a bearer token. The base URL is your project's region endpoint.
  </Step>

  <Step title="Configure in Courier">
    Open the <AppLink href="https://app.courier.com/integrations/catalog/airship">Airship Integration</AppLink> in Courier, enter your auth token and base URL, then click "Save."
  </Step>
</Steps>

## Profile requirements

Device tokens live on the user profile rather than on the send, so one profile can hold tokens for several devices and every push provider reads them from the same place. <Doc href="/docs/send/push/overview">Send push</Doc> covers the model.

Airship addresses the recipient by audience and device types, both under `airship` on the profile. Store them once with <Endpoint method="POST" path="/profiles/{user_id}" name="Create a Profile" href="/docs/api-reference/user-profiles/create-a-profile" />, which merges into the profile and creates it if it does not exist:

<CodeGroup>
  ```javascript Node.js highlight={3-10} theme={null}
  const profile = await client.profiles.create('user_123', {
    profile: {
      airship: {
        audience: {
          named_user: 'user_123',
        },
        device_types: [
          'ios',
        ],
      },
    },
  });
  ```

  ```python Python highlight={4-11} theme={null}
  profile = client.profiles.create(
      user_id="user_123",
      profile={
          "airship": {
              "audience": {
                  "named_user": "user_123",
              },
              "device_types": [
                  "ios",
              ],
          },
      },
  )
  ```

  ```bash cURL highlight={7-14} theme={null}
  curl --request POST \
    --url https://api.courier.com/profiles/user_123 \
    --header "Authorization: Bearer $COURIER_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{
      "profile": {
        "airship": {
          "audience": {
            "named_user": "user_123"
          },
          "device_types": [
            "ios"
          ]
        }
      }
    }'
  ```

  ```ruby Ruby highlight={4-9} theme={null}
  profile = courier.profiles.create(
    "user_123",
    profile: {
      airship: {
        audience: {
          named_user: "user_123"
        },
        device_types: ["ios"]
      }
    }
  )
  ```

  ```go Go highlight={6-11} theme={null}
  profile, err := client.Profiles.New(
  	context.TODO(),
  	"user_123",
  	courier.ProfileNewParams{
  		Profile: map[string]any{
  			"airship": map[string]any{
  				"audience": map[string]any{
  					"named_user": "user_123",
  				},
  				"device_types": []any{"ios"},
  			},
  		},
  	},
  )
  ```

  ```java Java highlight={4-7} theme={null}
  ProfileCreateParams params = ProfileCreateParams.builder()
      .userId("user_123")
      .profile(ProfileCreateParams.Profile.builder()
          .putAdditionalProperty("airship", JsonValue.from(java.util.Map.of(
              "audience", java.util.Map.of(
                  "named_user", "user_123"),
              "device_types", java.util.List.of("ios"))))
          .build())
      .build();
  ProfileCreateResponse profile = client.profiles().create(params);
  ```

  ```php PHP highlight={2-7} theme={null}
  $profile = $client->profiles->create('user_123', profile: [
    'airship' => [
      'audience' => [
        'named_user' => 'user_123',
      ],
      'device_types' => ['ios'],
    ],
  ]);
  ```

  ```csharp C# highlight={7-14} theme={null}
  ProfileCreateParams parameters = new()
  {
      UserID = "user_123",
      Profile = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
          """
          {
            "airship": {
              "audience": {
                "named_user": "user_123"
              },
              "device_types": [
                "ios"
              ]
            }
          }
          """
      ),
  };
  var profile = await client.Profiles.Create(parameters);
  ```

  ```bash CLI highlight={4} wrap theme={null}
  courier profiles create \
    --api-key "$COURIER_API_KEY" \
    --user-id user_123 \
    --profile '{"airship":{"audience":{"named_user":"user_123"},"device_types":["ios"]}}'
  ```

  ```text MCP theme={null}
  With Courier MCP, save the Airship named user user_123 on user_123, for iOS.
  ```
</CodeGroup>

Then send to `user_id` and Courier resolves the address.

For a one-off with no stored profile, pass it inline instead: `"to": { "airship": { "audience": { "named_user": "user_123" }, "device_types": ["ios"] } }`.

<CardGroup cols={1}>
  <Card title="Send by user id" icon="user" href="/docs/recipients/overview#send-by-user-id">
    The call in every language, and the rest of the profile object.
  </Card>
</CardGroup>

## Send to a recipient

<Tabs>
  <Tab title="Send to user id">
    Courier reads `airship` off the saved profile, so preferences apply and the value can change without touching this code.

    <CodeGroup>
      ```javascript Node.js highlight={4} theme={null}
      const { requestId } = await courier.send.message({
        message: {
          to: {
            user_id: "user_123",
          },
          template: "nt_01kx4h2jdafq8bk9aftxak4b40",
        },
      });
      ```

      ```python Python highlight={4} theme={null}
      response = client.send.message(
          message={
              "to": {
                  "user_id": "user_123",
              },
              "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
          },
      )
      ```

      ```bash cURL highlight={7} wrap theme={null}
      curl -X POST https://api.courier.com/send \
        -H "Authorization: Bearer $COURIER_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "message": {
            "to": {
              "user_id": "user_123"
            },
            "template": "nt_01kx4h2jdafq8bk9aftxak4b40"
          }
        }'
      ```

      ```ruby Ruby highlight={4} theme={null}
      response = courier.send_.message(
        message: {
          to: {
            user_id: "user_123"
          },
          template: "nt_01kx4h2jdafq8bk9aftxak4b40"
        }
      )
      ```

      ```go Go highlight={5} theme={null}
      response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
      	Message: courier.SendMessageParamsMessage{
      		To: courier.SendMessageParamsMessageToUnion{
      			OfUserRecipient: &shared.UserRecipientParam{
      				UserID: courier.String("user_123"),
      			},
      		},
      		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
      	},
      })
      ```

      ```java Java highlight={3} theme={null}
      SendMessageParams params = SendMessageParams.builder()
          .message(SendMessageParams.Message.builder()
              .to(UserRecipient.builder().userId("user_123").build())
              .template("nt_01kx4h2jdafq8bk9aftxak4b40")
              .build())
          .build();
      SendMessageResponse response = client.send().message(params);
      ```

      ```php PHP highlight={4} theme={null}
      $response = $client->send->message(
        message: [
          'to' => [
            'user_id' => 'user_123',
          ],
          'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
        ],
      );
      ```

      ```csharp C# highlight={5} theme={null}
      SendMessageParams parameters = new()
      {
          Message = new()
          {
              To = new UserRecipient { UserID = "user_123" },
              Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
          },
      };

      var response = await client.Send.Message(parameters);
      ```

      ```bash CLI highlight={3} wrap theme={null}
      courier send message \
        --api-key "$COURIER_API_KEY" \
        --message.to '{"user_id": "user_123"}' \
        --message.template nt_01kx4h2jdafq8bk9aftxak4b40
      ```

      ```text MCP theme={null}
      With Courier MCP, send my template to user_123 by email.
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Send to `airship`">
    Pass it inline instead and nothing is stored. Swap this `to` object into the call on the other tab.

    <CodeGroup>
      ```javascript Node.js highlight={5-10} theme={null}
      const { requestId } = await courier.send.message({
        message: {
          // A provider recipient is a profile field, so it sits outside the typed union.
          to: {
            airship: {
              audience: {
                named_user: "user_123",
              },
              device_types: ["ios"],
            },
          } as any,
          template: "nt_01kx4h2jdafq8bk9aftxak4b40",
        },
      });
      ```

      ```python Python highlight={4-9} theme={null}
      response = client.send.message(
          message={
              "to": {
                  "airship": {
                      "audience": {
                          "named_user": "user_123",
                      },
                      "device_types": ["ios"],
                  },
              },
              "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
          },
      )
      ```

      ```bash cURL highlight={7-14} wrap theme={null}
      curl -X POST https://api.courier.com/send \
        -H "Authorization: Bearer $COURIER_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "message": {
            "to": {
              "airship": {
                "audience": {
                  "named_user": "user_123"
                },
                "device_types": [
                  "ios"
                ]
              }
            },
            "template": "nt_01kx4h2jdafq8bk9aftxak4b40"
          }
        }'
      ```

      ```ruby Ruby highlight={4-9} theme={null}
      response = courier.send_.message(
        message: {
          to: {
            airship: {
              audience: {
                named_user: "user_123"
              },
              device_types: ["ios"]
            }
          },
          template: "nt_01kx4h2jdafq8bk9aftxak4b40"
        }
      )
      ```

      ```go Go highlight={2-4} theme={null}
      // A provider recipient is a profile field, so it sits outside the typed union.
      to := param.Override[shared.UserRecipientParam](
      	json.RawMessage(`{"airship": {"audience": {"named_user": "user_123"}, "device_types": ["ios"]}}`),
      )

      response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
      	Message: courier.SendMessageParamsMessage{
      		To: courier.SendMessageParamsMessageToUnion{OfUserRecipient: &to},
      		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
      	},
      })
      ```

      ```java Java highlight={3-6} theme={null}
      // A provider recipient is a profile field, so it sits outside the typed union.
      UserRecipient to = UserRecipient.builder()
          .putAdditionalProperty("airship", JsonValue.from(Map.of(
                  "audience", Map.of(
                      "named_user", "user_123"),
                  "device_types", List.of("ios"))))
          .build();

      client.send().message(SendMessageParams.builder()
          .message(SendMessageParams.Message.builder()
              .to(to)
              .template("nt_01kx4h2jdafq8bk9aftxak4b40")
              .build())
          .build());
      ```

      ```php PHP highlight={4-9} theme={null}
      $response = $client->send->message(
        message: [
          'to' => [
            'airship' => [
              'audience' => [
                'named_user' => 'user_123',
              ],
              'device_types' => ['ios'],
            ],
          ],
          'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
        ],
      );
      ```

      ```csharp C# highlight={3-5} theme={null}
      // A provider recipient is a profile field, so it sits outside the typed union.
      UserRecipient to = UserRecipient.FromRawUnchecked(
          JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
              """{"airship": {"audience": {"named_user": "user_123"}, "device_types": ["ios"]}}"""
          )
      );

      var response = await client.Send.Message(new() { Message = new() { To = to, Template = "nt_01kx4h2jdafq8bk9aftxak4b40" } });
      ```

      ```bash CLI highlight={3} wrap theme={null}
      courier send message \
        --api-key "$COURIER_API_KEY" \
        --message.to '{"airship": {"audience": {"named_user": "user_123"}, "device_types": ["ios"]}}' \
        --message.template nt_01kx4h2jdafq8bk9aftxak4b40
      ```

      ```text MCP theme={null}
      With Courier MCP, send my template to the Airship named user user_123.
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Overrides

<Doc href="/docs/send/overrides#how-overrides-work">How overrides work</Doc> covers the two levels and which one wins. <Doc href="/docs/integrations/push/overview#channel-overrides">Push channel overrides</Doc> lists the fields every push provider takes.

A provider override changes what Courier sends to Airship's API. For example, use basic auth on one send request:

<CodeGroup>
  ```javascript Node.js highlight={5-12,18-25} theme={null}
  const { requestId } = await courier.send.message({
    message: {
      template: "nt_01kx4h2jdafq8bk9aftxak4b40",
      to: {
        airship: {
          audience: {
            named_user: "user_123",
          },
          device_types: [
            "ios",
          ],
        },
      },
      data: {
        dataForPushMessage: true,
      },
      providers: {
        airship: {
          override: {
            body: {},
            headers: {
              Authorization: "Basic <EncodedAppKey:AppSecret>",
            },
          },
        },
      },
    },
  });
  ```

  ```python Python highlight={5-12,18-25} theme={null}
  response = client.send.message(
      message={
          "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
          "to": {
              "airship": {
                  "audience": {
                      "named_user": "user_123",
                  },
                  "device_types": [
                      "ios",
                  ],
              },
          },
          "data": {
              "dataForPushMessage": True,
          },
          "providers": {
              "airship": {
                  "override": {
                      "body": {},
                      "headers": {
                          "Authorization": "Basic <EncodedAppKey:AppSecret>",
                      },
                  },
              },
          },
      },
  )
  ```

  ```bash cURL highlight={8-15,21-28} wrap theme={null}
  curl -X POST https://api.courier.com/send \
    -H "Authorization: Bearer $COURIER_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "message": {
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "to": {
          "airship": {
            "audience": {
              "named_user": "user_123"
            },
            "device_types": [
              "ios"
            ]
          }
        },
        "data": {
          "dataForPushMessage": true
        },
        "providers": {
          "airship": {
            "override": {
              "body": {},
              "headers": {
                "Authorization": "Basic <EncodedAppKey:AppSecret>"
              }
            }
          }
        }
      }
    }'
  ```

  ```ruby Ruby highlight={5-12,18-25} theme={null}
  response = courier.send_.message(
    message: {
      template: "nt_01kx4h2jdafq8bk9aftxak4b40",
      to: {
        airship: {
          audience: {
            named_user: "user_123"
          },
          device_types: [
            "ios"
          ]
        }
      },
      data: {
        dataForPushMessage: true
      },
      providers: {
        airship: {
          override: {
            body: {},
            headers: {
              Authorization: "Basic <EncodedAppKey:AppSecret>"
            }
          }
        }
      }
    }
  )
  ```

  ```go Go highlight={4-11,22-29} theme={null}
  // This provider addresses the recipient with fields outside the typed
  // UserRecipient model, so pass the recipient as raw JSON.
  to := param.Override[shared.UserRecipientParam](json.RawMessage(`{
    "airship": {
      "audience": {
        "named_user": "user_123"
      },
      "device_types": [
        "ios"
      ]
    }
  }`))

  response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
  	Message: courier.SendMessageParamsMessage{
  		To: courier.SendMessageParamsMessageToUnion{OfUserRecipient: &to},
  		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
  		Data: map[string]any{
  			"dataForPushMessage": true,
  		},
  		Providers: shared.MessageProvidersParam{
  			"airship": shared.MessageProvidersTypeParam{
  				Override: map[string]any{
  					"body": map[string]any{},
  					"headers": map[string]any{
  						"Authorization": "Basic <EncodedAppKey:AppSecret>",
  					},
  				},
  			},
  		},
  	},
  })
  ```

  ```java Java highlight={6-13,20-25} theme={null}
  SendMessageParams params = SendMessageParams.builder()
      .message(SendMessageParams.Message.builder()
          // This provider addresses the recipient with fields outside the
          // typed UserRecipient model, so pass them as additional properties.
          .to(UserRecipient.builder()
              .putAdditionalProperty("airship", JsonValue.from(java.util.Map.of(
                  "audience", java.util.Map.of(
                      "named_user", "user_123"
                  ),
                  "device_types", java.util.List.of(
                      "ios"
                  )
              )))
              .build())
          .template("nt_01kx4h2jdafq8bk9aftxak4b40")
          .data(JsonValue.from(java.util.Map.of(
              "dataForPushMessage", true
          )))
          .providers(MessageProviders.builder()
              .putAdditionalProperty("airship", JsonValue.from(java.util.Map.of("override", java.util.Map.of(
                      "body", java.util.Map.of(),
                      "headers", java.util.Map.of(
                          "Authorization", "Basic <EncodedAppKey:AppSecret>"
                      )
                  ))))
              .build())
          .build())
      .build();
  SendMessageResponse response = client.send().message(params);
  ```

  ```php PHP highlight={5-12,18-25} theme={null}
  $response = $client->send->message(
    message: [
      'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
      'to' => [
        'airship' => [
          'audience' => [
            'named_user' => 'user_123',
          ],
          'device_types' => [
            'ios',
          ],
        ],
      ],
      'data' => [
        'dataForPushMessage' => true,
      ],
      'providers' => [
        'airship' => [
          'override' => [
            'body' => [],
            'headers' => [
              'Authorization' => 'Basic <EncodedAppKey:AppSecret>',
            ],
          ],
        ],
      ],
    ],
  );
  ```

  ```csharp C# highlight={11-18,30-45} theme={null}
  SendMessageParams parameters = new()
  {
      Message = new()
      {
          // This provider addresses the recipient with fields outside the
          // typed UserRecipient model, so build it from raw JSON.
          To = UserRecipient.FromRawUnchecked(
              JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                  """
                  {
                    "airship": {
                      "audience": {
                        "named_user": "user_123"
                      },
                      "device_types": [
                        "ios"
                      ]
                    }
                  }
                  """
              )
          ),
          Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
          Data = new Dictionary<string, JsonElement>()
          {
              { "dataForPushMessage", JsonSerializer.SerializeToElement(true) },
          },
          Providers = new Dictionary<string, MessageProvidersType>()
          {
              {
                  "airship",
                  new()
                  {
                      Override = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                          """
                          {
                            "body": {},
                            "headers": {
                              "Authorization": "Basic <EncodedAppKey:AppSecret>"
                            }
                          }
                          """
                      ),
                  }
              },
          },
      },
  };

  var response = await client.Send.Message(parameters);
  ```

  ```bash CLI highlight={3,6} wrap theme={null}
  courier send message \
    --api-key "$COURIER_API_KEY" \
    --message.to '{"airship": {"audience": {"named_user": "user_123"}, "device_types": ["ios"]}}' \
    --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
    --message.data '{"dataForPushMessage": true}' \
    --message.providers '{"airship": {"override": {"body": {}, "headers": {"Authorization": "Basic <EncodedAppKey:AppSecret>"}}}}'
  ```

  ```text MCP theme={null}
  With Courier MCP, send my template through Airship using basic auth on this one send.
  ```
</CodeGroup>

Overrides are deep-merged into the request. Fields you set replace their counterparts, and everything you leave out is still sent. The full field list is in [Airship's API docs](https://docs.airship.com/api/ua/).

## Tracking events

Courier puts the tracking URL in the `global_attributes` data bag. See <Doc href="/docs/integrations/push/overview#tracking">push notification tracking</Doc> for details.

## Provider details

```text theme={null}
airship
```

Courier recommends routing to the channel. Naming this key in `routing.channels` instead is supported, and sends through just this provider.

<Card title="Send to a specific provider" icon="bullseye-arrow" href="/docs/send/send-to-a-provider" horizontal arrow="true">
  When that is worth doing, and what you give up: failover, channel priority, and providers you add later.
</Card>