Skip to main content
POST
Stop participant

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

id
string
required

Initiative id.

Minimum string length: 1
participantId
string
required

Participant id, as returned when adding or listing.

Minimum string length: 1

Response

Success

stopped
boolean
required
status
enum<string>
required

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

Available options:
ACTIVE,
COMPLETED,
STOPPED,
EXPIRED,
FAILED