Fixar / Desafixar mensagens
Método#
/pin-message#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/pin-message
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Neste método você poderá fixar mensagens de uma conversa, seja chats privados ou grupos.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| phone | string | Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara |
| messageId | string | Id da mensagem que será fixada ou desafixada |
| messageAction | string | Ação que será executada para a mensagem: fixada ou desafixada (pin, unpin) |
| pinMessageDuration | string | Tempo em que a mensagem ficará fixada. Não tem efeito no caso de desafixar uma mensagem. |
Request Body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| zaapId | string | id no z-api |
| messageId | string | id no whatsapp |
| id | string | Adicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId |
Exemplo
405#
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"
Webhook Response#
Link para a response do webhook (ao receber)