v1

latestOpenAPI 3.0.02026-07-267581167.5 KB
Broadcast API

Get broadcasts

get/companies/{company_key}/mobiledb/broadcasts

Path parameters

company_keystring required

Query parameters

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

Headers

X-API-Versionstring

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.