Skip to main content
POST
Transition lead status (guarded)

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

leadId
string
required

Lead id

Body

application/json
toStatus
enum<string>
required
Available options:
pending_turndown,
PromotedToCase,
matched_to_firm_match_direct,
waiting_for_retainer
turnDownReason
string
Maximum string length: 200
turnDownNotes
string
Maximum string length: 2000

Response

{ success: true, lead }

success
boolean
required
{key}
any