---
title: "Update a notification channel"
method: PUT
path: "/v5/notifications/channels/{channelId}"
tags: ["Notifications"]
---

# Update a notification channel

`PUT /v5/notifications/channels/{channelId}`

## Request

- Base URL: `https://api.kadoa.com`
- URL: `https://api.kadoa.com/v5/notifications/channels/{channelId}`
- Auth: API key in header `x-api-key`

## Path parameters

- `channelId` string, required

## Request body

- object
  - `name` string, required
  - `channelType` 'EMAIL' | 'SLACK' | 'WEBHOOK' | 'WEBSOCKET', required
  - `config` union, required: Configuration object specific to the channel type
    - object
      - `recipients` string[], required: Array of recipient email addresses
      - `from` string, email: Sender email address (optional, must be a @kadoa.com domain email)
    - object
      - `webhookUrl` string, uri: Slack webhook URL (optional)
      - `slackChannelId` string, required: Slack channel ID
      - `slackChannelName` string, required: Slack channel name
    - object
      - `webhookUrl` string, uri, required: Webhook endpoint URL
      - `httpMethod` 'POST' | 'GET' | 'PUT' | 'PATCH', required: HTTP method for the webhook
      - `auth` object: Authentication configuration (optional)
        - `type` 'bearer' | 'basic' | 'header': Authentication type
        - `token` string: Bearer token (for bearer auth)
        - `username` string: Username (for basic auth)
        - `password` string: Password (for basic auth)
        - `headers` object: Additional headers (for header auth)
    - object: WebSocket channel configuration. Note - Only one WebSocket channel is allowed per workspace. Leave empty object {} as no configuration is needed.

## Response `200`

Channel updated successfully

- object
  - `data` object
    - `channel` object
  - `status` string
  - `message` string

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `404`: Channel not found
- `500`: Internal server error

---

[API](https://skmtc.dev/kadoa/apis/kadoa-api.md) · [All operations](https://skmtc.dev/kadoa/apis/kadoa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kadoa/apis/kadoa-api/revisions/bf7803c927b4?raw)