USuseboom
Initiatives

Archive initiative

Changed on

Hide an initiative from the default list. Takes a draft, completed or canceled one — a draft created by mistake does not have to be canceled first — but not a running (active or paused) one. Nothing else about the initiative changes, and unarchive reverses it.

post/api/v1/initiatives/{id}/archive

Request

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

Path parameters

idstring required

The initiative id.

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 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