Pular para o conteúdo principal
POST
/
instances
/
{id}
/
chatwoot
Salvar configuracao Chatwoot da instancia
curl --request POST \
  --url https://api.vzaps.com/instances/{id}/chatwoot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "url": "<string>",
  "account_id": "<string>",
  "name_inbox": "<string>",
  "token": "<string>",
  "sign_msg": true,
  "sign_delimiter": "\\n",
  "number": "<string>",
  "reopen_conversation": true,
  "conversation_pending": true,
  "import_contacts": true,
  "import_messages": true,
  "days_limit_import_messages": 2,
  "auto_create": true,
  "organization": "<string>",
  "logo": "<string>",
  "ignore_jids": [
    "<string>"
  ],
  "ignore_groups": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "instance_id": "<string>",
  "enabled": true,
  "url": "<string>",
  "account_id": "<string>",
  "token_masked": "<string>",
  "name_inbox": "<string>",
  "inbox_id": 123,
  "inbox_identifier": "<string>",
  "sign_msg": true,
  "sign_delimiter": "\\n",
  "number": "<string>",
  "reopen_conversation": true,
  "conversation_pending": true,
  "import_contacts": true,
  "import_messages": true,
  "days_limit_import_messages": 2,
  "organization": "<string>",
  "logo": "<string>",
  "ignore_jids": [
    "<string>"
  ],
  "ignore_groups": true,
  "webhook_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Autorizações

​
Authorization
string
header
obrigatório

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

Parâmetros de caminho

​
id
string
obrigatório

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Corpo

application/json
​
enabled
boolean
obrigatório
​
url
string
obrigatório
​
account_id
string
obrigatório
​
name_inbox
string
obrigatório
​
token
string

Token de acesso do usuario do Chatwoot. Pode ser omitido para manter o token atual.

​
sign_msg
boolean
​
sign_delimiter
string
Exemplo:

"\\n"

​
number
string
​
reopen_conversation
boolean
​
conversation_pending
boolean
​
import_contacts
boolean
​
import_messages
boolean
​
days_limit_import_messages
integer
Intervalo obrigatório: x >= 1
​
auto_create
boolean

Quando true, tenta criar automaticamente a inbox API no Chatwoot durante o save.

​
organization
string
​
ignore_jids
string[]
​
ignore_groups
boolean

Resposta

Configuracao Chatwoot salva

​
id
string<uuid>
​
instance_id
string
​
enabled
boolean
​
url
string

URL base do Chatwoot sem barra final.

​
account_id
string

ID numerico da conta no Chatwoot.

​
token_masked
string

Token mascarado retornado pela API para nao expor o segredo completo.

​
name_inbox
string
​
inbox_id
integer | null
​
inbox_identifier
string
​
sign_msg
boolean
​
sign_delimiter
string
Exemplo:

"\\n"

​
number
string
​
reopen_conversation
boolean
​
conversation_pending
boolean
​
import_contacts
boolean
​
import_messages
boolean
​
days_limit_import_messages
integer
Intervalo obrigatório: x >= 1
​
organization
string
​
ignore_jids
string[]
​
ignore_groups
boolean
​
webhook_url
string

URL que deve ser configurada no inbox API do Chatwoot.

​
created_at
string<date-time>
​
updated_at
string<date-time>