Skip to main content
PATCH
Configure (Step 2): set isActive / channelSpecificConfig / credentials

Autorizações

X-Api-Key
string
header
obrigatório

Parâmetros de caminho

agentPublicId
string<uuid>
obrigatório
channelConnectionPublicId
string<uuid>
obrigatório

Corpo

application/json

Body for configuring an agent's channel link (state, config, credentials).

channelSpecificConfig
object

Channel-specific configuration object. Shape depends on the channel type.

credentials
object

Channel credentials. Stored opaquely; never returned in responses.

isActive
boolean

Whether the channel is currently active.

Exemplo:

true

Resposta

OK

Agent channel connection. credentials NEVER returned.

channelName
string
channelSpecificConfig
object
channelType
string
createdAt
string<date-time>
instanceMode
enum<string>
Opções disponíveis:
STATIC,
DYNAMIC
isActive
boolean
isConfigured
boolean
publicId
string<uuid>
updatedAt
string<date-time>