Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
pin-message
Fixar / Desafixar mensagens
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/pin-message \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "messageId": "<string>",
  "messageAction": "<string>",
  "pinMessageDuration": "<string>"
}
'

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

Neste método você poderá fixar mensagens de uma conversa, seja chats privados ou grupos.

​
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.

​
Obrigatórios

​
phone
string
obrigatório
Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999
​
messageId
string
obrigatório
ID da mensagem que será fixada ou desafixada
​
messageAction
string
obrigatório
Ação que será executada para a mensagem: pin (fixar) ou unpin (desafixar)
​
pinMessageDuration
string
obrigatório
Tempo em que a mensagem ficará fixada: 24_hours, 7_days ou 30_days. Não tem efeito no caso de desafixar uma mensagem.

​
Request Body

{
  "phone": "5511999999999",
  "messageId": "77DF5293EBC176FFA6A88838E7A6AD83",
  "messageAction": "pin",
  "pinMessageDuration": "7_days"
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET 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”.