Skip to content

`PUT /api/v1/channels/{id}` — update a notification channel (Admin only).

PUT
/api/v1/channels/{id}
curl --request PUT \
--url https://example.com/api/v1/channels/example \
--header 'Content-Type: application/json' \
--data '{ "config": "example", "name": "example" }'
id
required
string

Channel ID

Media type application/json

Request body for PUT /api/v1/channels/{id}.

object
config

New config (optional).

name

New name (optional).

string | null
Example generated
{
"config": "example",
"name": "example"
}

Channel updated

Media type application/json

Response body for a single notification channel.

object
channel_type
required
string
config
required
created_at
required
integer format: int64
created_by
required
string
id
required
string
name
required
string
Example generated
{
"channel_type": "example",
"config": "example",
"created_at": 1,
"created_by": "example",
"id": "example",
"name": "example"
}

Invalid request body

Admin role required

Channel not found