---
title: "Update a Pub/Sub channel"
method: PUT
path: "/v3/channels/pubsub/{id}"
tags: ["Pub/Sub Notifications"]
---

# Update a Pub/Sub channel

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

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](/docs/reference/api/#updating-objects).

## Path parameters

- `id` string, required

## Request body

- object
  - `description` string — A human-readable description of the Pub/Sub 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 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_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 compresses notification payloads using gzip before delivering them. Nylas adds a `content_encoding: gzip` message attribute to the Pub/Sub message.

## Response `200`

Pub/Sub channel updated

- object
  - `data` object
    - `id` string — A unique identifier for the Pub/Sub channel.
    - `description` string — A human-readable description of the Pub/Sub 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 Google Pub/Sub topic that Nylas sends notifications to.
    - `status` 'active' | 'pause' | 'failing' | 'failed' — The deliverability status of the Pub/Sub channel.
    - `notification_email_addresses` string[] — The email addresses that Nylas notifies if delivery to the Pub/Sub channel fails.
    - `compressed_delivery` boolean — If `true`, Nylas compresses notification payloads using gzip 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 Pub/Sub channel was created, represented as a Unix timestamp in seconds.
    - `updated_at` integer — The time the Pub/Sub 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` — Pub/Sub 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)