message

pin message

Pin a message in a chat

post/instances/{id}/client/action/pin-message

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/pin-message
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

messageIdstring required

The ID of the message to pin

durationinteger nullable

Optional duration in seconds for how long the message should stay pinned

Example request

{
  "messageId": "true_123456789@c.us_123ABC456DEF",
  "duration": 86400
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success",
    "data": {
      "messageId": "true_123456789@c.us_123ABC456DEF",
      "pinned": true
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/pin-message"
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.