---
title: "Update an Amazon SNS channel"
method: PUT
path: "/v3/channels/sns/{id}"
tags: ["Amazon SNS Notifications"]
---

# Update an Amazon SNS channel

`PUT /v3/channels/sns/{id}`

Updates the specified Amazon SNS notification channel.

When you make a `PUT` request, Nylas replaces all data in the nested object with the information
included in your request. For more information, see
[Updating objects](/docs/reference/api/#updating-objects).

## Path parameters

- `id` string, required

## Request body

- object
  - `description` string — A human-readable description of the Amazon SNS 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. Must start with `arn:aws:sns:`.
  - `role_arn` string — The ARN of the IAM role that Nylas assumes to publish messages to the SNS topic.
  - `status` 'active' | 'pause' — The new status of the channel. Use this to restart a channel that you manually paused, or that was automatically paused due to deliverability issues.
  - `notification_email_addresses` string[] — The email addresses that Nylas notifies if there are errors or deliverability problems. See the [rate limit documentation](/docs/dev-guide/best-practices/rate-limits/) for details.
  - `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.

## Response `200`

Amazon SNS channel updated

- object
  - `data` object
    - `id` string — A unique identifier for the Amazon SNS channel.
    - `description` string — A human-readable description of the Amazon SNS 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' | 'pause' | 'failing' | 'failed' — The deliverability status of the Amazon SNS channel.
    - `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.
    - `status_updated_at` integer — The time the `status` field was last updated, represented as a Unix timestamp in seconds.
    - `created_at` integer — The time the Amazon SNS channel was created, represented as a Unix timestamp in seconds.
    - `updated_at` integer — The time the Amazon SNS channel was last updated, represented as a Unix timestamp in seconds.
  - `request_id` string — The unique ID of the request that generated this response.

## Other responses

- `400` — Amazon SNS channel not updated

---

[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)