Pins or unpins one message in a WhatsApp group. Members see the change in WhatsApp.

Before you call

• Pass the group's groupId and the messageId of a message in the group, from Get WhatsApp group chat messages.
• To pin, send action: pin with expirationDays (1 to 30). To unpin, send action: unpin without expirationDays.
• The API key's user needs permission to modify WhatsApp groups on the group's number.
• The WhatsApp number must be an admin of the group, and the group must have finished creating on WhatsApp.

How it works

• Pins or unpins one message per request on WhatsApp, then records it and returns the message's pin state.
• A pin ends on its own after expirationDays.
• A group keeps at most 3 pinned messages: pinning another one unpins the oldest pinned message, listed in autoUnpinnedMessageIds.
• Only one pin or unpin can run per group at a time: an overlapping request gets a 409, so retry it after a moment.
• Returns 400 if the message has not reached WhatsApp yet, or if WhatsApp refuses the request.

Rate limit

• 30 requests per minute.