Sign in

v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB
channels

Update Channel

put/api/v1/channels/

Request body

namestring required

The channel name

channel_service'sip' | 'twilio' | 'email' | 'webchat' | 'africastalking' | 'whatsapp' required

The communication service for a channel.

supported_modesstring nullable

The comma-delimited list of supported modes for the channel, which defines the possible communication methods for channel targets linked to it.

is_system_channelboolean

Whether the channel is a built-in system channel (i.e., is not customizable)

idinteger required

The internal ID of the channel

Example request

{
  "name": "twilio",
  "supported_modes": "chat,voice",
  "config": {
    "account_sid": "AC123...",
    "auth_token": "sometoken",
    "provider_credentials": {
      "api_key": "atk123",
      "username": "test_username"
    },
    "telephony": {
      "sip_configuration": {
        "sip_endpoints": [
          {
            "host": "10.0.0.1",
            "port": "5060",
            "transport": "tcp"
          },
          {
            "host": "pbx.example.com",
            "port": "5071",
            "transport": "tls"
          }
        ]
      }
    },
    "email": {
      "sending_domain": "mail.example.com"
    }
  },
  "id": 1
}

Response

Successful Response

namestring required

The channel name

channel_service'sip' | 'twilio' | 'email' | 'webchat' | 'africastalking' | 'whatsapp' required

The communication service for a channel.

supported_modesstring nullable

The comma-delimited list of supported modes for the channel, which defines the possible communication methods for channel targets linked to it.

is_system_channelboolean

Whether the channel is a built-in system channel (i.e., is not customizable)

idinteger required

The channel ID

Example response

{
  "name": "syllable-webchat",
  "supported_modes": "chat,voice",
  "config": {
    "telephony": {
      "sip_configuration": {
        "sip_endpoints": [
          {
            "host": "10.0.0.1",
            "port": "5060",
            "transport": "tcp"
          },
          {
            "host": "pbx.example.com",
            "port": "5071",
            "transport": "tls"
          }
        ]
      }
    },
    "email": {
      "sending_domain": "mail.example.com"
    },
    "credentials": {
      "account_sid_last_four": "1234"
    }
  }
}