USuseboom
Initiatives

Update initiative

Changed on

Edit an initiative. A launched one still takes its agent-facing content (name, objective, context, guidingQuestions, flagCondition, identityDeflection) and its smartSendingMode and serves the edit on the next turn; the structural fields are draft-only, and a completed or canceled initiative is frozen. Send only the fields you change; context and objective replace the whole value, so read the current value first and send it back with your addition.

patch/api/v1/initiatives/{id}

Request

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

Path parameters

idstring required

The initiative id.

Request body

namestring

Initiative name.

language'en' | 'es' | 'pt'
objectivestring

What the initiative aims to learn.

contextstring

Background the conversation draws on.

maxAttemptsinteger

Outreach attempts per participant. Default 3.

isRecurringboolean

Splits campaigns from initiatives: false is a campaign (one-time outreach, listed under Campaigns), true is an initiative (ongoing work, listed under Initiatives). A Transactional is a third kind, set with transactional on create, and cannot be recurring. A campaign auto-completes once its outreach run finishes; an initiative stays ACTIVE afterward, though no scheduled process currently re-triggers outreach for it. No UI control changes this after creation. Default false.

flagConditionstring nullable

Natural-language condition; conversations matching it get flagged during analysis. Set null to clear.

smartSendingMode'DEFER' | 'DROP' | 'FORCE'

Smart Sending for this initiative's template, SMS and email sends, when the org has a frequency cap. FORCE always sends (and still counts toward the cap); DROP skips a send that would exceed it; DEFER currently behaves as DROP.

identityDeflectionstring nullable

Custom reply when a contact asks whether they are talking to a bot. Set null to clear.

Response

Success

idstring required

Initiative id.

namestring required
channel'WHATSAPP' | 'EMAIL' required

Which identifier this initiative reaches people by, derived from its journey: EMAIL when the journey only mails, WHATSAPP when anything phone-shaped sends. See sendChannels for what it actually sends on — this field cannot express SMS or the Meta DMs.

sendChannelsstring[] required

Every channel this initiative's journey sends on — the authoritative answer. Empty when it has no journey yet, in which case channel falls back to the value stored at creation.

status'DRAFT' | 'ACTIVE' | 'PAUSED' | 'COMPLETED' | 'CANCELED' required
languagestring required

Conversation language, e.g. es.

objectivestring nullable required
isRecurringboolean required

Splits campaigns from initiatives (a Transactional is the third kind, see isTransactional): false is a campaign (one-time outreach, listed under Campaigns), true is an initiative (ongoing work, listed under Initiatives). A campaign auto-completes once its outreach run finishes; an initiative stays ACTIVE afterward, though no scheduled process currently re-triggers outreach for it.

isTransactionalboolean required

True for a Transactional (one event, one message per channel; listed under Transactional).

flagConditionstring nullable required

Natural-language condition; matching conversations get flagged during analysis.

identityDeflectionstring nullable required

Custom reply when a contact asks whether they are talking to a bot.

smartSendingMode'DEFER' | 'DROP' | 'FORCE' required

Smart Sending mode: DEFER, DROP or FORCE.

createdAtstring required

ISO 8601 timestamp.

updatedAtstring required

ISO 8601 timestamp.

activatedAtstring nullable required
completedAtstring nullable required
canceledAtstring nullable required
pausedAtstring nullable required
contextstring nullable required
maxAttemptsinteger required

Changes

  • 7c7a773b12ceRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property's maxLength was increased from 5000 to 20000

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status