PATCH
/
v1
/
channels
/
{channel_id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

channel_id
string
required

Body

application/json
convore_mail
object
name
string

Name of the channel

status
enum<string>

The status of the channel.

Available options:
active,
disabled

Response

200 - application/json
addresses
object[]
required

A collection of communication addresses associated with the channel. These addresses are used for sending and receiving messages, ensuring proper routing and delivery of content. Each address specifies a unique handle, such as an email or a phone number, along with associated details like the participant's name and role.

connector_id
string
required

Unique identifier for the channel's connector

convore_mail
object

The specific convore mail channel information

created_at
string
required

The ISO 8601 time at which the Channel was created.

id
string
required

Unique identifier for the channel

name
string
required

Name of the channel

provider
enum<string>
required

The provider type

Available options:
convore_mail,
gmail,
ses
ses
object

The specific ses channel information

status
enum<string>
required

The status of the channel.

Available options:
active,
disabled