Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
modify-chat
curl --request POST \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/modify-chat \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "{{PHONE}}",
  "action": "read"
}
'
{
  "value": true
}
{
  "error": "Unauthorized",
  "message": "Invalid instanceToken"
}
{
  "error": "Instance not found"
}
{
  "error": "Worker command timeout"
}
{
  "error": "Unable to process request"
}
Arquiva, fixa, silencia, marca como lida, limpa ou deleta a conversa.
Aliases consolidados da collection: Ler chat, Arquivar chat, Fixar chat, Mutar chat, Limpar chat, Deletar chat.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

Body

application/json
​
phone
string
required
Example:

"{{PHONE}}"

​
action
string
required
Example:

"read"

Response

Resposta de sucesso.

​
value
boolean
required
Example:

true