Skip to main content
PATCH
/
notifications
/
api
/
v1
/
notifications
/
channels
/
{channel_id}
Update a notification channel
curl --request PATCH \
  --url https://www.closient.com/notifications/api/v1/notifications/channels/{channel_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "enabled": true,
  "label": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "verified": true,
  "enabled": true
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
channel_id
string
required

UUID of the notification channel to update.

Body

application/json

Request body for partial updates to a notification channel.

Both fields are optional — omit a field to leave its current value unchanged. Sending enabled=false is the canonical way to pause delivery without deleting the channel.

​
enabled
boolean | null

Set to false to pause delivery, true to resume. Omit to leave unchanged.

​
label
string | null

New display label for this channel. Omit to leave unchanged.

Maximum string length: 100

Response

OK

A user-owned notification channel (email address, SMS number, in-app inbox).

Each user may register multiple channels of the same type — for example, a personal and a work email. Returned by all channel endpoints.

​
id
string<uuid>
required

Unique channel identifier (UUIDv4).

​
channel_type
enum<string>
required

Delivery channel for this contact point. email and sms deliver out-of-band; in_app is rendered in the user's notification center.

Available options:
email,
sms,
in_app
​
label
string
required

User-assigned label that disambiguates channels of the same type (e.g. Work Email vs Personal Email).

Maximum string length: 100
​
verified
boolean
required

Whether the user has confirmed ownership of this channel (e.g. clicked a verification link or replied to an SMS code). Unverified channels do not receive notifications.

​
enabled
boolean
required

Whether notifications are currently delivered to this channel. Set to false to pause delivery without deleting the channel.