USuseboom
Initiatives

Configure Transactional

Changed on

Set up or change a Transactional in one call: the event, optionally the field that identifies each send, its messages with variable bindings, and whether sends wait in Drafts for approval. Only the fields you pass change (null clears one). The journey is rebuilt for you, and a live Transactional goes live with the change immediately. Returns the setup plus missing: what still blocks initiatives_launch, each with how to fix it. Calling it with only id resets a journey edited outside the standard shape.

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

Request

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

Path parameters

idstring required

The Transactional id.

Request body

eventNamestring nullable

The CDP event that sends the messages, e.g. "payment_link_created". Letters, numbers and underscores only. null clears it.

parallelRunsBystring nullable

Optional. Unset (the default) sends one notification per event, one at a time per customer. Set it to an event property, usually an id such as "orderId", for one notification per value: each value sends once per customer, ever, and an event without it sends nothing. null clears it.

reviewBeforeSendingboolean

Every send waits in Drafts until an org member approves or rejects it (drafts_list, drafts_decide); a rejected email still lets the WhatsApp message go. Without parallelRunsBy, a customer's next event is dropped while their earlier send waits, so set a key when events can repeat. Refused (drafts_disabled) while drafts are turned off for the organization.

Response

Success

idstring required
eventNamestring nullable required
parallelRunsBystring nullable required
reviewBeforeSendingboolean required
journeyStatus'DRAFT' | 'PUBLISHED' | 'STOPPED' nullable required
readyToLaunchboolean required

True when nothing below blocks initiatives_launch.

Changes