> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt > Use this file to discover all available pages before exploring further. # Update a channel > Renames a channel, replaces its destinations, or turns it on or off. Requires a realm operator (or higher) with the `channels.manage.realm` permission on the realm that owns the notification channel given by `id`. For an organization-level notification channel, a role with `channels.manage` in that organization. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-notification-channels.yaml post /v1/notification_channels/update openapi: 3.0.3 info: title: 'CliqHub API: Notification channels' version: 1.0.0 description: >- Where notifications go. A channel has one or more destinations (Slack, email, a webhook, the CliqHub inbox, or another channel by name) and belongs to an organization or a realm; names are unique within that scope. Notification rules (on Organizations and Realms) decide which events reach which channel. Built-in channels cannot be changed or removed. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Notification channels description: >- Where notifications go. A channel has one or more destinations (Slack, email, a webhook, the CliqHub inbox, or another channel by name) and belongs to an organization or a realm; names are unique within that scope. Notification rules (on Organizations and Realms) decide which events reach which channel. Built-in channels cannot be changed or removed. paths: /v1/notification_channels/update: post: tags: - Notification channels summary: Update a channel description: >- Renames a channel, replaces its destinations, or turns it on or off. Requires a realm operator (or higher) with the `channels.manage.realm` permission on the realm that owns the notification channel given by `id`. For an organization-level notification channel, a role with `channels.manage` in that organization. operationId: POST_v1_notification_channels_update requestBody: required: true content: application/json: schema: type: object properties: id: type: string description: Channel id to update name: type: string description: New name (must remain unique in scope) destinations: type: array items: description: Unresolved Zod schema `destination_schema` type: object additionalProperties: true minItems: 1 description: Replace the full destinations list when set enabled: type: boolean description: Enable or disable the channel required: - id examples: default: value: id: 9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b enabled: false responses: '200': description: Success. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: $ref: '#/components/schemas/NotificationChannelData' example: ok: true data: id: 9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b realm_id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b org_id: null user_id: null name: ops-slack destinations: - type: slack webhook_url: https://hooks.slack.com/services/T000/B000/XXXX enabled: true created_at: 1759000000000 updated_at: 1759000000000 rule_count: 1 system_key: null locked: false lock_reason: null '400': description: >- `bad_request`: `name` is empty, or `channel_ref` destinations form a loop. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: bad_request: summary: bad_request value: ok: false error: name is required code: bad_request '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required '403': description: >- `forbidden`: You can see the record but your role in its realm is too low or lacks the required permission. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: forbidden: summary: forbidden value: ok: false error: code: forbidden message: You do not have access to do this '404': description: >- `not_found`: The notification channel does not exist or is in a realm you cannot see (404 rather than 403, so its existence is not revealed). content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found '409': description: >- `locked`: The channel is a built-in channel. `details.system_key` names it. `conflict`: The new name is already used in the scope. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: locked: summary: locked value: ok: false error: Channel 'Invites' is a system channel and can't be changed code: locked conflict: summary: conflict value: ok: false error: >- A channel named 'ops' already exists in realm "Production". Choose a different name. code: conflict '422': description: >- `invalid_params`: The body fails the request schema: a required field is missing or a value has the wrong type or format. The message lists every issue as `field: problem`. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: 'id: Required' code: invalid_params '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: internal_error: summary: internal_error value: ok: false error: Internal server error code: internal_error security: - BearerAuth: [] components: schemas: NotificationChannelData: type: object properties: id: type: string description: Channel UUID realm_id: type: string nullable: true description: Owning realm, or null for org/account channels org_id: type: string nullable: true description: Owning org for account channels user_id: type: string nullable: true description: Owning user for personal account channels name: type: string description: Unique name within the realm or org scope destinations: type: array items: description: Unresolved Zod schema `destination_schema` type: object additionalProperties: true description: >- Delivery destinations — typed array where each item has a fixed `type` (slack | email | webhook | http | jira | cliqhub | channel_ref) and type-specific required fields enabled: type: number description: 1 = enabled, 0 = disabled created_at: type: number description: Create time (unix ms) updated_at: type: number description: Last update time (unix ms) rule_count: type: number description: Number of notification rules pointing at this channel system_key: type: string nullable: true description: Stable key of a channel CliqHub seeded (e.g. org.email), else null locked: type: boolean description: True when the channel cannot be changed or removed (409 locked) lock_reason: type: string nullable: true description: Why the channel is locked required: - id - realm_id - name - destinations - enabled - created_at - updated_at - system_key - locked - lock_reason HubErr: type: object required: - ok - error description: >- Every failure. Route-policy denials (401/403/404, and 400 when neither realm_id nor org_id was sent) answer `error` as `{ code, message }`; errors raised by the endpoint answer `error` as the message with the code beside it in `code`. Every error has a code. See [Errors](/hub-api/errors). properties: ok: type: boolean description: Always false on error error: description: The message, or `{ code, message }` for an access denial. oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string code: type: string description: Stable error code of an endpoint error. details: type: object additionalProperties: true description: Structured detail, when there is some. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: cliq_tok_* | cliq_dt_* description: >- User PAT (`cliq_tok_…`, including session-scoped) or realm token (`cliq_dt_…`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.