Skip to main content
POST
/
v1
/
whatsapp
/
groups
/
{groupId}
/
messages
/
pin
cURL
curl --request POST \
  --url https://api.buildwithchirp.com/v1/whatsapp/groups/{groupId}/messages/pin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messageId": "wamid.xxx",
  "expirationDays": 7
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Path Parameters

​
groupId
string
required

WhatsApp Group ID

Example:

"grp_wa_2DbBs7GWhGvVNJGrDXr5RG0"

Body

application/json
​
messageId
string
required

Meta message ID to pin

Example:

"wamid.xxx"

​
expirationDays
integer

Number of days before the pin expires (1-30, default: 7)

Required range: 1 <= x <= 30
Example:

7

Response

Message pinned

​
success
enum<boolean>
required
Available options:
true,
false