USuseboom
Initiatives

Configure campaign

Changed on

Change a campaign in one call: its audience, send time, messages with variable bindings, or review before sending. Only the fields you pass change (null clears one). The journey is rebuilt for you; a scheduled campaign takes the change immediately. The send time of a scheduled campaign cannot move once people are waiting for it. Returns the setup plus missing: what still blocks initiatives_launch.

patch/api/v1/initiatives/{id}/campaign

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

The campaign id.

Request body

sendAtstring date-time nullable

ISO instant the message goes out, in the future. Null = as soon as the campaign is scheduled.

reviewBeforeSendingboolean

Response

Success

idstring required
formBuiltboolean required

False when the one-time initiative was built by hand: it has no campaign setup, edit its journey instead.

sendAtstring nullable required
audienceCountnumber nullable required

Segment members right now; null for a manual audience.

reviewBeforeSendingboolean required
journeyStatus'DRAFT' | 'PUBLISHED' | 'STOPPED' nullable required
readyToScheduleboolean required

True when nothing below blocks initiatives_launch.

Changes