Create a channel

Create a channel in an inbox.

Required scope: channels:write

Path Params
string
required
Defaults to inb_123

The Inbox ID

Body Params

Channel to create

string

Name of the channel

settings
object

Settings of the channel

string
enum
required

Type of the channel

Allowed:
string

Sending address of your channel. Required for SMTP and Twilio channels.

string

The UID of a developer app that defines a channel. When provided, an application
channel bound to that app is created (the channel type must be "custom").

credentials
object

Credentials used to authenticate requests to the application's service. Only used with
application_uid, and its shape depends on the application server's authentication type:

  • none: omit.
  • api_key: { "api_key": string }.
  • basic: { "username": string, "password": string }.
  • bearer: { "access_token": string }.
  • OAuth2 client_credentials: { "client_id": string, "client_secret": string }
  • OAuth2 password: { "username": string, "password": string }
  • OAuth2 authorization_code: omit. The channel is created unauthenticated and the OAuth
    flow must be completed interactively afterwards.
Response
204

No content

Language
Credentials
Bearer
JWT
LoadingLoading…