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

# Pin / Unpin messages

> Pin or unpin a message in a private chat or group

## Overview

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

#### Example on WhatsApp

<div style={{ display: "flex", justifyContent: "center" }}>
  <img src="https://mintcdn.com/z-api-8aa3bb40/nNYp_QHy_iUs4_xM/images/send-pin-message-eng.jpg?fit=max&auto=format&n=nNYp_QHy_iUs4_xM&q=85&s=e4fa94adf95dc88c8080f22d0d04e477" width="400" data-path="images/send-pin-message-eng.jpg" />
</div>

***

## Attributes

### Header

<ParamField path="instanceId" type="string" required>
  Your instance ID. Available in the Z-API panel under **Instances**.
</ParamField>

<ParamField path="token" type="string" required>
  Your Z-API instance token.
</ParamField>

### Required

<ParamField body="phone" type="string" required>
  Recipient's phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999
</ParamField>

<ParamField body="messageId" type="string" required>
  ID of the message to be pinned or unpinned
</ParamField>

<ParamField body="messageAction" type="string" required>
  Action to be executed: `pin` or `unpin`
</ParamField>

<ParamField body="pinMessageDuration" type="string" required>
  Duration the message will remain pinned: `24_hours`, `7_days` or `30_days`. Has no effect when unpinning a message.
</ParamField>

***

## Request Body

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "phone": "5511999999999",
  "messageId": "77DF5293EBC176FFA6A88838E7A6AD83",
  "messageAction": "pin",
  "pinMessageDuration": "7_days"
}
```

***

## Response

### 200

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "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".
