Sign in

v1

latestOpenAPI 3.1.02026-07-22750642.5 KB
Initiatives

Archive initiative

Archive a completed or canceled initiative, hiding it from the default list. Reversible with unarchive.

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

Path parameters

idstring required

The initiative id.

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