Skip to main content
POST
Finalizar automação do chat

Authorizations

Authorization
string
header
required

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

Body

application/json

Informe chatInternalId, chatId ou phoneNumber. O phoneNumber é buscado por aproximação, então informe o integrationId sempre que o mesmo número puder existir em mais de uma integração. Havendo mais de um chat, o que tem a mensagem mais recente é utilizado.

chatInternalId
string

ID interno do chat (obrigatório se chatId e phoneNumber não forem informados)

Pattern: ^c[a-z0-9]{24}$
chatId
string

ID do chat no canal, por exemplo 5511999999999@s.whatsapp.net (obrigatório se chatInternalId e phoneNumber não forem informados)

Minimum string length: 1
phoneNumber
string

Número de telefone do contato, em qualquer formato (obrigatório se chatInternalId e chatId não forem informados)

Required string length: 8 - 30
integrationId
string

ID da integração, restringe a busca feita pelo chatId ou pelo phoneNumber

Pattern: ^c[a-z0-9]{24}$

Response

Requisição processada com sucesso

success
boolean

Indica se a operação foi bem-sucedida

message
string

Descreve qual automação foi finalizada ou informa que o chat não possui automação ativa

data
object