Broadcasts

Create a broadcast draft

Creates a draft. Nothing sends and the recipient list isn't fixed until the broadcast is approved.

API key scopes: broadcasts:write. You also need an Idempotency-Key header.

post/api/broadcasts

Request

  • Base URL: https://api.setluca.com
  • URL: https://api.setluca.com/api/broadcasts
  • Auth: one of:
    • API key in cookie luca.session_token
    • API key in header x-api-key
    • HTTP bearer

Headers

Luca-API-Version'1'

The major version of the API this client was built against. Omit it and the request is served by the current major version. Any other value is refused with 400 unsupported_api_version.

Request body

campaignIdstring uuid required
namestring required
personalizationMode'same_message' | 'personalized_light' | 'personalized_ai'
canarySizeinteger
batchSizeinteger

Response

ok

idstring uuid required
campaignIdstring uuid required
campaignVersionIdstring uuid nullable required
namestring required
status'draft' | 'previewed' | 'approved' | 'running' | 'paused' | 'cancelled' | 'completed' | 'failed' required
personalizationMode'same_message' | 'personalized_light' | 'personalized_ai' required
totalRecipientsinteger required
canarySizeinteger required
batchSizeinteger required
sentCountinteger required
failedCountinteger required
skippedCountinteger required
previewVersionstring nullable required
createdAtstring required
updatedAtstring required
approvedAtstring nullable required
launchedAtstring nullable required
pausedAtstring nullable required
cancelledAtstring nullable required
completedAtstring nullable required
recipientsTruncatedboolean
retryBlockedReason'provider_acceptance_unknown' nullable

Changes

No recorded changes to this operation across all 1 revision of this API.