Skip to main content
POST
Pin / Unpin messages

Overview

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

Example on WhatsApp


Attributes

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

Required

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

Request Body


Response

200

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