Create Pinned Message

Create a new pinned message.

Automatically deactivates previous active message. If broadcast=true, sends to all active users immediately.

POST /cabinet/admin/pinned-messages

Create Pinned Message

cURL

curl --request POST \
  --url https://api.example.com/cabinet/admin/pinned-messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "media": {
    "type": "<string>",
    "file_id": "<string>"
  },
  "send_before_menu": true,
  "send_on_every_start": true,
  "broadcast": false
}
'

201

{
  "message": {
    "id": 123,
    "content": "<string>",
    "send_before_menu": true,
    "send_on_every_start": true,
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "media_type": "<string>",
    "media_file_id": "<string>",
    "created_by": 123,
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "sent_count": 123,
  "failed_count": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

content · string · required

Required string length: 1 - 4000

media · PinnedMessageMedia · object

Show child attributes

send_before_menu · boolean · default: true

send_on_every_start · boolean · default: true

broadcast · boolean · default: false

Response

201

application/json

Successful Response

message · PinnedMessageResponse · object · required

Show child attributes

sent_count · integer · required

failed_count · integer · required