Skip to main content
PATCH
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The broadcast's prefixed id (e.g. bcst_abc123).

Body

application/json
from
string | null

Sender email address (uses account default if omitted)

to
string[]

List of recipient email addresses

subject
string

Email subject line. Takes the same variables as body.

preview_text
string | null

Inbox preview line. Takes the same variables as body.

Maximum string length: 255
body
string

Email body (HTML or plain text). Variables, filled per recipient from their customer record when each batch is sent: {{customer.first_name}}, {{customer.last_name}}, {{customer.email}}, {{business.name}}, {{customer.fields.}}. customer.fields.<key> reads <key> from the customer's metadata. An address in to that belongs to no customer is sent without customer data, so its variables render blank or as their defaults. Put {{unsubscribe_url}} in an href to place the recipient's opt-out link. Any other {{ }} is rejected with 422.

customer_type
string | null

Filter recipients by customer type

send_to_all
boolean | null

Send to all customers

Response

The updated broadcast

object
string
required
id
string
required
subject
string | null
required
preview_text
string | null
required
body
string | null
required
html_body
string | null
required
from
string | null
required
reply_to
string | null
required
styled
boolean
required
audience
object
required
audience_description
string
required
status
enum<string>
required
Available options:
draft,
scheduled,
sending,
sent,
canceled,
failed
scheduled_at
string<date-time> | null
required
started_at
string<date-time> | null
required
sent_at
string<date-time> | null
required
canceled_at
string<date-time> | null
required
stats
object
required
error
string | null
required
metadata
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required