v1

latestOpenAPI 3.0.02026-07-267581167.5 KB
Broadcast API

Cancel a broadcast

delete/companies/{company_key}/mobiledb/broadcasts/{broadcast_id}

Path parameters

company_keystring required
broadcast_idstring required
<div style="color:#dd1e2e; background:url(https://d2xs7zaan7w9gl.cloudfront.net/data/pages/64014/widgets/48027d01-e827-45e0-b96d-227c1099eedc/image/1680214872.png?icon-24x24-warning.png) no-repeat 10px center; background-color:#FCEAEC; padding:10px; font-size:13px;"><div style="padding-left:35px"><b>Important:</b> If you are entering a live broadcast_id, please note that using the <b>"Try It"</b> feature on the righthand console will send an actual API call to our system. This may result in the live broadcast being canceled.</div></div>

Headers

X-API-Versionstring
Content-Typestring required

Response

Successful response

broadcast_idstring

Vibes unique identifier for the broadcast.

status'scheduled' | 'in_progress' | 'sent' | 'canceled' | 'deleted' | 'paused' | 'failed'

The status of the broadcast.

namestring

The name of the campaign.

send_scheduled_datestring

The date the campaign is scheduled to send.

created_bystring

The user that created the campaign.

created_by_applicationstring

The application that created the campaign, if applicable.