Sign in
Pub/Sub Notifications

Update a Pub/Sub channel

Updates the specified Pub/Sub 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/pubsub/{id}

Path parameters

idstring required

The ID of the Pub/Sub channel to retrieve.

Request body

descriptionstring

A human-readable description of the Pub/Sub 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 Google Pub/Sub topic that Nylas sends notifications to.

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 compresses notification payloads using gzip before delivering them. Nylas adds a content_encoding: gzip message attribute to the Pub/Sub message.

Example request

{
  "description": "Prod account status notifications PubSub",
  "topic": "projects/your-project-id/topics/your-topic-id",
  "notification_email_addresses": [
    "sysadmin@example.com",
    "sre_pager@example.com"
  ],
  "compressed_delivery": true
}

Response

Pub/Sub channel updated

request_idstring

The unique ID of the request that generated this response.

Example response

{
  "data": {
    "id": "UMWjAjMeWQ4D8gYF2moonK4486",
    "description": "Production Pub/Sub channel",
    "topic": "projects/your-project-id/topics/your-topic-id",
    "notification_email_addresses": [
      "jane@example.com",
      "joe@example.com"
    ],
    "status_updated_at": 1234567890,
    "created_at": 1234567890,
    "updated_at": 1234567890
  }
}

Changes