Pin Message

Supported & Tested

Pin a message in a chat for a selected duration.

POSThttps://api.waplix.io/api/v1/messages/pin
Authentication
Authorization: Bearer YOUR_API_KEY
Parameters Specification
instance_id
stringReq

Required Waplix instance id

message_id
stringReq

Required WhatsApp message id or local log id

duration
numberOpt

Optional duration in seconds (e.g. 86400, 604800, or 2592000)

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/pin" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instance_id": "demo_instance",
  "message_id": "MSG_DEMO_001",
  "chat_id": "15551234567@s.whatsapp.net",
  "duration": 86400
}'
Success Response
Response · 200 OK
{
  "success": true,
  "data": {
    "instance_id": "demo_instance",
    "message_id": "MSG_DEMO_001",
    "duration": 86400,
    "status": "pinned",
    "confirmed": true
  }
}
Was this page helpful?