Skip to main content
PUT
/
v1
/
users
/
me
/
notifications
/
channels
/
{id}
Update a notification channel
curl --request PUT \
  --url http://localhost:8080/v1/users/me/notifications/channels/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "config": {},
  "is_active": true
}
'
{
  "id": "unc_cq1234567890abcdef",
  "user_id": "<string>",
  "channel_type": "email",
  "name": "<string>",
  "config": {},
  "is_verified": true,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Path Parameters

id
string
required

Resource identifier (xid format)

Body

application/json
name
string
config
object
is_active
boolean

Response

Channel updated

id
string
Example:

"unc_cq1234567890abcdef"

user_id
string
channel_type
enum<string>
Available options:
email,
slack,
teams
name
string
config
object
is_verified
boolean
is_active
boolean
created_at
string<date-time>
updated_at
string<date-time>