Pular para o conteúdo principal
DELETE
/
instances
/
{instanceId}
/
token
/
{token}
/
messages
Deletar mensagens
curl --request DELETE \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/messages \
  --header 'Client-Token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Método utilizado para apagar uma mensagem em um chat, você pode deletar tanto uma mensagem que enviou quanto uma mensagem enviada por um contato, para utilizar este recurso você só vai precisar do messageId da mensagem que quer apagar.

​
Exemplo no WhatsApp

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Query Parameters

​
messageId
string
obrigatório
ID original da mensagem
​
phone
string
obrigatório
Telefone (ou ID do grupo para casos de envio para grupos) do destinatário/remetente no formato DDI DDD NÚMERO. Ex: 551199999999
​
owner
boolean
obrigatório
Informe true caso você tenha enviado a mensagem ou false para casos onde seja uma mensagem recebida

​
Exemplo de requisição

​
URL exemplo

DELETE https://api.z-api.io/instances/{instanceId}/token/{instanceToken}/messages?messageId=123&phone=5511999998888&owner=true

​
Response

​
204

No content 
{}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o DELETE conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.