Update a channel

PATCH

/api/v1/channels/{id}

curl --request PATCH \
  --url https://renotify.app/api/v1/channels/architecto \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Primary WhatsApp", "credentials": { "api_token": "new-secret-token" }, "metadata": { "phone_number": "+15551234567" }, "is_default": true, "status": "active" }'

Update the configuration for an existing messaging channel.

Authorizations

• default

Parameters

Path Parameters

id

required

string

The ID of the channel.

Example

architecto

Request Body

Media typeapplication/json

object

name

The channel name.

string

Example

Primary WhatsApp

credentials

Provider credentials to merge into the channel.

object

Example

{
  "api_token": "new-secret-token"
}

metadata

Additional metadata to merge into the channel.

object

Example

{
  "phone_number": "+15551234567"
}

is_default

Whether this should become the default channel.

boolean

Example

true

status

The channel status.

string

Example

active

Responses