---
title: "Create an Amazon SNS channel"
method: POST
path: "/v3/channels/sns"
tags: ["Amazon SNS Notifications"]
---

# Create an Amazon SNS channel

`POST /v3/channels/sns`

Create an Amazon SNS notification channel in the specified application.

The `topic` must be a valid Amazon SNS topic ARN (starting with `arn:aws:sns:`).

## Request body

- AmazonSnsInputPayload
  - `description` string — A human-readable description of the Amazon SNS channel.
  - `trigger_types` string[], required — The event that triggers the notification. See the [notification schemas](/docs/reference/notifications/) for details about each trigger type. See the [Grants](/docs/reference/api/manage-grants/), [Calendar](/docs/reference/api/calendar/), [Events](/docs/reference/api/events/), and [Messages](/docs/reference/api/messages/) references for information on how to trigger each event type.
  - `topic` string, required — The Amazon SNS topic ARN that Nylas sends notifications to. Must start with `arn:aws:sns:`.
  - `role_arn` string, required — The ARN of the IAM role that Nylas assumes to publish messages to the SNS topic. Must match `arn:aws:iam::<account-id>:role/<role-name>`.
  - `notification_email_addresses` string[] — The email addresses that Nylas notifies if delivery to the Amazon SNS channel fails.
  - `compressed_delivery` boolean — If `true`, Nylas gzip-compresses and then base64-encodes notification payloads before delivering them. Nylas adds a `content_encoding: gzip+base64` message attribute to the SNS message. To decode, base64-decode the message body, then gzip-decompress. Default is `false`.

## Response `200`

Amazon SNS channel created

- object
  - `data` object
    - `id` string — A unique identifier for the Amazon SNS notification channel.
    - `description` string — A human-readable description of the Amazon SNS notification channel.
    - `trigger_types` string[] — The event that triggers the notification. See the [notification schemas](/docs/reference/notifications/) for details about each trigger type. See the [Grants](/docs/reference/api/manage-grants/), [Calendar](/docs/reference/api/calendar/), [Events](/docs/reference/api/events/), and [Messages](/docs/reference/api/messages/) references for information on how to trigger each event type.
    - `topic` string — The Amazon SNS topic ARN that Nylas sends notifications to.
    - `role_arn` string — The ARN of the IAM role that Nylas assumes to publish messages to the SNS topic.
    - `status` 'active' — The status of the Amazon SNS channel. When you first create a new channel, Nylas sets it to "active".
    - `notification_email_addresses` string[] — The email addresses that Nylas notifies if delivery to the Amazon SNS channel fails.
    - `compressed_delivery` boolean — If `true`, Nylas gzip-compresses and then base64-encodes notification payloads before delivering them.
  - `request_id` string — The unique ID of the request that generated this response.

## Other responses

- `400` — Unable to create Amazon SNS channel

---

[API](https://skmtc.dev/nylas/apis/nylas-api.md) · [All operations](https://skmtc.dev/nylas/apis/nylas-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nylas/nylas-api/revisions/51c2c1b4ecff/schema)