Skip to main content
POST
Criar canal

Authorizations

Authorization
string
header
required

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

Body

application/json
project_id
string<uuid>
required

Projeto em que o canal é criado.

name
string
required

Nome do canal. No máximo 255 caracteres.

Maximum string length: 255
audience
enum<string>

Quem vê o canal. internal restringe à equipe; client deixa visível ao cliente. O padrão é internal.

Available options:
internal,
client
integration_id
string<uuid>

Integração de comunicação à qual o canal se liga.

external_ref
string

Identificador do contato no conector, enviado exatamente como informado.

Maximum string length: 255
is_active
boolean

Se o canal nasce ativo. O padrão é true.

force_takeover
boolean

Encerra a conversa ativa com o mesmo destinatário e ativa este canal. Se várias conversas ativas com o mesmo contato forem permitidas, só encerra outra conversa ativa neste projeto.

close_reason
string

Nota registrada na conversa encerrada. No máximo 500 caracteres.

Maximum string length: 500

Response

Sucesso

response
boolean
channel
object