Skip to main content
POST
/
cabinet
/
admin
/
broadcasts
Create Broadcast
curl --request POST \
  --url http://localhost:8080/cabinet/admin/broadcasts \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "<string>",
  "message_text": "<string>",
  "selected_buttons": [
    "<string>"
  ],
  "media": {
    "type": "<string>",
    "file_id": "<string>",
    "caption": "<string>"
  }
}
'
{
  "id": 123,
  "target_type": "<string>",
  "has_media": true,
  "total_count": 123,
  "sent_count": 123,
  "failed_count": 123,
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "message_text": "<string>",
  "media_type": "<string>",
  "media_file_id": "<string>",
  "media_caption": "<string>",
  "blocked_count": 0,
  "admin_id": 123,
  "admin_name": "<string>",
  "completed_at": "2023-11-07T05:31:56Z",
  "progress_percent": 0,
  "channel": "telegram",
  "email_subject": "<string>",
  "email_html_content": "<string>"
}

Body

application/json

Request to create a broadcast.

target
string
required
message_text
string
required
Required string length: 1 - 4000
selected_buttons
string[]
media
BroadcastMediaRequest · object

Media attachment for broadcast.

Response

Successful Response

Broadcast response.

id
integer
required
target_type
string
required
has_media
boolean
required
total_count
integer
required
sent_count
integer
required
failed_count
integer
required
status
string
required
created_at
string<date-time>
required
message_text
string | null
media_type
string | null
media_file_id
string | null
media_caption
string | null
blocked_count
integer
default:0
admin_id
integer | null
admin_name
string | null
completed_at
string<date-time> | null
progress_percent
number
default:0
channel
string
default:telegram
email_subject
string | null
email_html_content
string | null