FRfrontapp
Channels

Create a channel

Changed on

Create a channel in an inbox.

Required scope: channels:write

post/inboxes/{inbox_id}/channels

Request

  • Base URL
    https://api2.frontapp.com
  • URL
    https://api2.frontapp.com/inboxes/{inbox_id}/channels
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The Inbox ID

Request body

namestring

Name of the channel

type'custom' | 'smtp' | 'twilio' required

Type of the channel

send_asstring

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

application_uidstring

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").

credentialsobject

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

No content

Changes

  • d5ddea1da69eRevision changes
    • breaking

      request body became required

    • info

      added the new optional request property

    • info

      added the new optional request property