Skip to main content
PUT
Update broadcast

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Path Parameters

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
name
string
Minimum string length: 1
subject
string
Minimum string length: 1
from_email
string<email>
from_name
string
reply_to
string<email> | null
preview_text
string | null
Maximum string length: 500
template_id
string<uuid> | null
segment_id
string<uuid> | null
topic_id
string<uuid> | null
scheduled_at
string<date-time> | null
inbox_id
string<uuid> | null

Optional inbox ID. When provided, the inbox's name, from address, and reply-to address are used as defaults unless explicit values are given. Set to null to remove inbox association. Mutually exclusive with inbox_ids.

Example:

"123e4567-e89b-12d3-a456-426614174000"

inbox_ids
string<uuid>[] | null

Optional array of inbox IDs for inbox rotation. Each inbox's sender identity is used for its portion of emails. Set to null or empty to disable rotation. Mutually exclusive with inbox_id.

sending_speed
enum<string> | null

Controls how fast emails are sent.

Available options:
auto,
warmup,
very_slow,
slow,
normal,
instant
sequence_exit_conditions
object | null

Configurable exit rules for the sequence dispatcher. Recipients matching any rule are removed from the sequence before the next follow-up.

sequence_mode
enum<string>

How follow-ups are sent. sales (default) = threaded replies. marketing = fresh standalone emails per step.

Available options:
sales,
marketing
tags
string[]

Tags for categorization. Lowercase, max 50 chars each, max 20 tags.

Example:

Response

Broadcast updated

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>
required
name
string
required
subject
string
required
from_email
string<email>
required
from_name
string | null
required
reply_to
string | null
required
preview_text
string | null
required
template_id
string<uuid> | null
required
segment_id
string<uuid> | null
required
topic_id
string<uuid> | null
required

Topic ID for categorizing the broadcast

Example:

"123e4567-e89b-12d3-a456-426614174000"

inbox_id
string<uuid> | null
required

Associated inbox ID for sender identity defaults

Example:

"123e4567-e89b-12d3-a456-426614174000"

inbox_ids
string[] | null
required

Inbox IDs used for inbox rotation

sending_speed
string | null
required

Sending speed setting for the broadcast

Example:

"auto"

status
string
required
Example:

"draft"

total_recipients
number | null
required
sent_count
number | null
required
delivered_count
number | null
required
opened_count
number | null
required
clicked_count
number | null
required
bounced_count
number | null
required
scheduled_at
string<date-time> | null
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
tags
string[]
required

Tags for categorization.

Example:
sequence_mode
enum<string>
required

Whether follow-ups are sent as threaded replies (sales) or fresh standalone emails (marketing).

Available options:
sales,
marketing
Example:

"sales"

created_by
string<uuid> | null
required
created_at
string<date-time>
required
sequence_exit_conditions
object | null

Configurable exit rules evaluated by the sequence dispatcher before each follow-up. Supported keys: exit_if_in_segment_ids (string[]), exit_if_not_in_segment_ids (string[]).