USuseboom
Initiatives

Stop participant

End one participant’s run: no further scheduled messages are sent and their session is closed. Idempotent and safe — it never sends. Their answers and transcript stay readable, and the conversation keeps whoever it was assigned to.

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

Request

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

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.

Changes

No recorded changes to this operation across all 3 revisions of this API.