---
title: "Update Channel"
method: PATCH
path: "/api/v1/notifications/channels/{channel_id}"
tags: ["channels"]
---

# Update Channel

`PATCH /api/v1/notifications/channels/{channel_id}`

## Request

- Base URL: `https://platform-api.transform.unstructured.io` (the document declares no server; this is the origin it was published from)
- URL: `https://platform-api.transform.unstructured.io/api/v1/notifications/channels/{channel_id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/unstructured/apis/platform-api/docs/api/v1/notifications/channels/:channel_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update account-level notification channel.

Updates an existing channel. Only provided fields are updated.

## Path parameters

- `channel_id` string, required

## Headers

- `unstructured-api-key` string, nullable

## Request body

- UpdateChannelRequest: Common fields for all channel update requests.
  - `channel_type` 'webhook' | 'email': Notification delivery channel types.
  - `description` string, nullable: Channel description
  - `event_types` NotificationEventType[], nullable: Event types to subscribe to
  - `enabled` boolean, nullable: Enable/disable channel
  - `url` string, nullable: Webhook endpoint URL (HTTPS required)
  - `secret` string, nullable: Consumer-supplied signing secret (24-75 bytes). Pass empty string to remove custom secret.
  - `email_config` EmailChannelConfigUpdate: User-configurable email settings.
    - `cc` string[], nullable: CC email addresses (if provider supports)
    - `reply_to` string, email, nullable: Reply-to email address
    - `recipient_email` string, email, nullable: Primary recipient email address

## Response `200`

Successful Response

- union
  - WebhookChannelResponse: Response for webhook notification channel.
    - `channel_type` 'webhook'
    - `id` string, required: Channel ID
    - `description` string, nullable: Channel description
    - `event_types` string[], required: Subscribed event types
    - `enabled` boolean, required: Channel enabled status
    - `created_at` string, date-time, required: Creation timestamp
    - `updated_at` string, date-time, required: Last update timestamp
    - `url` string, required: Webhook endpoint URL
  - EmailChannelResponse: Response for email notification channel.
    - `channel_type` 'email'
    - `id` string, required: Channel ID
    - `description` string, nullable: Channel description
    - `event_types` string[], required: Subscribed event types
    - `enabled` boolean, required: Channel enabled status
    - `created_at` string, date-time, required: Creation timestamp
    - `updated_at` string, date-time, required: Last update timestamp
    - `email_config` EmailChannelConfigResponse, required: Email config in response (no sensitive data).
      - `cc` string[], nullable: CC email addresses (if provider supports)
      - `reply_to` string, email, nullable: Reply-to email address
      - `recipient_email` string, email, required: Primary recipient email address
      - `provider` string, required: Email provider (read-only, from platform config)

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/unstructured/apis/platform-api.md) - [All operations](https://skmtc.dev/unstructured/apis/platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unstructured/apis/platform-api/revisions/16b4542093db?raw)