Broadcasts

Create a broadcast

Creates a broadcast. Omit scheduled_at to save a draft, pass a future timestamp to schedule it, or pass send_now: true to resolve the audience and start sending immediately.

Sending a 1:1 email? Use POST /v1/email/inboxes/{inbox_id}/messages instead — it creates a tracked thread you can reply within.

post/broadcasts

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/broadcasts
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Request body

fromstring nullable

Sender email address (uses account default if omitted)

tostring[]

List of recipient email addresses

subjectstring

Email subject line

bodystring

Email body content

customer_typestring nullable

Filter recipients by customer type

send_to_allboolean nullable

Send to all customers

Response

The created broadcast

objectstring required
idstring required
subjectstring nullable required
preview_textstring nullable required
bodystring nullable required
html_bodystring nullable required
fromstring nullable required
reply_tostring nullable required
styledboolean required
audienceobject required
audience_descriptionstring required
status'draft' | 'scheduled' | 'sending' | 'sent' | 'canceled' | 'failed' required
scheduled_atstring date-time nullable required
started_atstring date-time nullable required
sent_atstring date-time nullable required
canceled_atstring date-time nullable required
statsobject required
errorstring nullable required
metadataobject required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.