Broadcasts

Retrieve a broadcast

Returns a broadcast, including its current delivery and engagement stats.

get/broadcasts/{id}

Request

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

Path parameters

idstring required

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

Response

The 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.