Skip to main content
POST
Create Broadcast

Authorizations

Authorization
string
header
required

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

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 | null

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