Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
pin-message
Pin / Unpin messages
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.

​
Overview

With this method you can pin messages in a conversation, whether private chats or groups.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
phone
string
required
Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999
​
messageId
string
required
ID of the message to be pinned or unpinned
​
messageAction
string
required
Action to be executed: pin or unpin
​
pinMessageDuration
string
required
Duration the message will remain pinned: 24_hours, 7_days or 30_days. Has no effect when unpinning a message.

​
Request Body

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

​
Response

​
200

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

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.