Skip to main content
GET
Check a campaign is ready to launch

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

campaignId
string
required

The campaign's id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Response

Whether the campaign can launch now, and who it would reach.

ready
boolean
required
people
object
required

The people on the campaign's lists.

reason
string

When it cannot launch: the code launching would answer with, such as campaign_has_no_steps.