Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
message

Pin Message

This endpoint pins or unpins a message based on the message_id or queue_id

post/message/{message_id}/pin

Headers

x-phonestring
Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Request body

pinboolean required

Whether to pin (true) or unpin (false) the message

time1 | 7 | 30
  • Duration in days for how long the message stays pinned
  • Accepted values: 1 (1 day), 7 (7 days), 30 (30 days)
  • Defaults to 30 days if not provided
  • Only applies when pin is true

Example request

{
  "pin": true,
  "time": 7
}

Response

204

object required

204 No Content