v1

latestOpenAPI 3.1.02026-07-22750642.5 KB

Initiatives

Update initiative

Edit a draft initiative. Only draft initiatives are editable.

patch/api/v1/initiatives/{id}

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

Recurring initiative: keeps processing newly added participants on a schedule instead of ending after one pass. Default false.

flagConditionstring nullable

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

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

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

languagestring required

Conversation language, e.g. es.

objectivestring nullable required

isRecurringboolean required

Whether the initiative keeps processing newly added participants on a schedule.

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.

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