Activate Pinned Message

Активировать закреплённое сообщение.

Деактивирует текущее активное сообщение и активирует указанное.

• broadcast=False (по умолчанию): пользователи увидят при следующем /start
• broadcast=True: рассылает сообщение всем активным пользователям сразу

POST /pinned-messages/{message_id}/activate

Activate Pinned Message

cURL

curl --request POST \
  --url https://api.example.com/pinned-messages/{message_id}/activate \
  --header 'X-API-Key: <api-key>'

200

{
  "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

X-API-Key · string · header · required

Path Parameters

message_id · integer · required

Query Parameters

broadcast · boolean · default: false

Разослать сообщение всем пользователям (по умолчанию False — только при /start)

Response

200

application/json

Successful Response

message · PinnedMessageResponse · object · required

Show child attributes

sent_count · integer · required

failed_count · integer · required