Skip to main content
POST
Create Broadcast

Authorizations

Authorization
string
header
required

Pass a Dugble team token in the Authorization header as Bearer . Team token secrets use the dgb_team_ prefix.

Headers

Idempotency-Key
string

Optional idempotency key for mutation requests. Maximum 256 characters.

Maximum string length: 256

Body

application/json
segment_id
string<uuid>
required
subject
string
required
html
string
required
name
string
topic_id
string<uuid> | null
from_email
string<email> | null
from_name
string | null
reply_to_email
string<email> | null
preview_text
string | null
text
string | null
variable_bindings
object
send
boolean
default:false
scheduled_at
string<date-time> | null

When send is true, a future timestamp schedules delivery instead of queueing immediately.

Response

Broadcast created successfully.

success
enum<boolean>
Available options:
true
data
object