Skip to main content
PUT
Set the audience

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

blastId
string<uuid>
required

Blast ID.

Body

application/json

Attach an existing list.

source
enum<string>
required

Use an existing list.

Available options:
existing
list_id
string<uuid>
required

List to attach.

Response

Audience attached.

An email blast. approval_readiness is included only while the blast is a draft.

blast_id
string<uuid>
required

Blast ID.

type
string
required

Always email_blast.

name
string
required

Blast name.

status
enum<string>
required

Lifecycle state.

Available options:
draft,
scheduled,
sending,
sent,
failed,
cancelled,
archived
description
string | null

Description.

audience_list_id
string | null

List backing the audience.

audience_source
string | null

existing or inline.

audience
object | null

Attached audience, or null when not set.

email_id
string | null

Email attached to the blast.

email_source
string | null

existing or inline.

email
object | null

Attached email summary, or null when not set.

operational
boolean

True for operational/transactional sends: unsubscribed contacts are not suppressed and the unsubscribe footer is skipped.

scheduled_at
string<date-time> | null

Scheduled send time (UTC).

approved_at
string<date-time> | null

When the attached email was approved for this blast.

approved_email_version
integer | null

Email version locked in for the send.

sent_at
string<date-time> | null

When the send completed.

send_mode
string | null

scheduled or send_now.

details
object

Send and engagement counters.

approval_readiness
object

Readiness summary included on draft blasts and on campaign_not_ready errors.

created_at
string<date-time>

Creation time.

updated_at
string<date-time>

Last update.