v1

latestOpenAPI 3.1.02026-07-22750642.5 KB
Initiatives

Stop participant

Stop all messaging to one participant and close their conversation. Idempotent and safe — it never sends. Their answers and transcript stay readable.

post/api/v1/initiatives/{id}/participants/{participantId}/stop

Path parameters

idstring required

Initiative id.

participantIdstring required

Participant id, as returned when adding or listing.

Response

Success

stoppedtrue required
status'ACTIVE' | 'COMPLETED' | 'STOPPED' | 'EXPIRED' | 'FAILED' required

ACTIVE (conversation may still happen), COMPLETED, STOPPED (messaging halted), EXPIRED, or FAILED.