Sign in
Amazon SNS Notifications

Update an Amazon SNS channel

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.

put/v3/channels/sns/{id}

Path parameters

idstring required

The ID of the Amazon SNS channel to update.

Request body

descriptionstring

A human-readable description of the Amazon SNS channel.

trigger_typesstring[]

The event that triggers the notification. See the notification schemas for details about each trigger type.

See the Grants, Calendar, Events, and Messages references for information on how to trigger each event type.

topicstring

The Amazon SNS topic ARN that Nylas sends notifications to. Must start with arn:aws:sns:.

role_arnstring

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_addressesstring[]

The email addresses that Nylas notifies if there are errors or deliverability problems. See the rate limit documentation for details.

compressed_deliveryboolean

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.

Example request

{
  "description": "Prod account status notifications SNS",
  "topic": "arn:aws:sns:us-east-1:123456789012:my-topic",
  "role_arn": "arn:aws:iam::123456789012:role/nylas-sns-role",
  "notification_email_addresses": [
    "sysadmin@example.com",
    "sre_pager@example.com"
  ],
  "compressed_delivery": true
}

Response

Amazon SNS channel updated

request_idstring

The unique ID of the request that generated this response.

Example response

{
  "data": {
    "id": "UMWjAjMeWQ4D8gYF2moonK4486",
    "description": "Production SNS channel",
    "topic": "arn:aws:sns:us-east-1:123456789012:my-topic",
    "role_arn": "arn:aws:iam::123456789012:role/nylas-sns-role",
    "notification_email_addresses": [
      "jane@example.com",
      "joe@example.com"
    ],
    "status_updated_at": 1234567890,
    "created_at": 1234567890,
    "updated_at": 1234567890
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.