Get Pinned Messages

Supported & Tested

List pinned messages in a chat.

POSThttps://api.waplix.io/api/v1/messages/pinned

Authentication

Authorization: Bearer YOUR_API_KEY

Parameters Specification

Parameter	Type	Required	Description
instance_id	`string`	Required	Required Waplix instance id
chat_id	`string`	Required	Required phone number or WhatsApp JID

instance_id

stringReq

Required Waplix instance id

chat_id

stringReq

Required phone number or WhatsApp JID

Usage Notes

Verified on production. Public documentation uses sanitized example data only.

Request Payload Example

Request

curl -X POST "https://api.waplix.io/api/v1/api/v1/messages/pinned" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instance_id": "demo_instance",
  "chat_id": "15551234567@s.whatsapp.net"
}'

Success Response

Response · 200 OK

{
  "success": true,
  "data": {
    "instance_id": "demo_instance",
    "chat_id": "15551234567@s.whatsapp.net",
    "items": []
  }
}

Previous Get Message Mentions Next Get Message Status

Was this page helpful?