Broadcasts

Refresh broadcast segment preview and sample messages

Freezes who matches right now and renders the exact sample the coach can approve. Preview again after any audience or campaign change.

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

post/api/broadcasts/{id}/preview

Request

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

Path parameters

idstring uuid required

Identifier of the broadcast this operation targets.

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

sampleSizeinteger

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.