Skip to main content
POST
/
cabinet
/
admin
/
pinned-messages
Create Pinned Message
curl --request POST \
  --url http://localhost:8080/cabinet/admin/pinned-messages \
  --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
}
'
{
  "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
}

Body

application/json
content
string
required
Required string length: 1 - 4000
media
PinnedMessageMedia · object
send_before_menu
boolean
default:true
send_on_every_start
boolean
default:true
broadcast
boolean
default:false

Response

Successful Response

message
PinnedMessageResponse · object
required
sent_count
integer
required
failed_count
integer
required