Sign in

v1

latestOpenAPI 3.0.02026-07-267581167.5 KB
Broadcast API

Create a broadcast

post/companies/{company_key}/mobiledb/broadcasts/

Path parameters

company_keystring 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> Please note that the <b>"Try It"</b> feature to the right will send an actual API call to our system, which may result in a new broadcast being created.</div></div>

Headers

X-API-Versionstring
Content-Typestring required

Request body

namestring required

The name of the campaign.

send_scheduled_datestring required

The date and time the campaign is scheduled to send in ISO-8601 format.

Example request

{
  "send_scheduled_date": "2017-02-16T17:30:00Z",
  "send_schedule": {
    "method": "by_time_zone",
    "send_date": "yyyy-mm-dd",
    "send_time": "17:30",
    "default_time_zone": "America/Chicago"
  },
  "targeting": {
    "short_url_base": "https://vbs.cm/",
    "source_short_code": {
      "source_type": "SC"
    }
  }
}

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.