Skip to main content
PATCH
Update a lead

Authorizations

x-api-key
string
header
required

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

Path Parameters

leadId
string
required

Lead id

Body

application/json

PATCH rejects leadStatus combined with any lemonLaw object or, for effective caseType "Lemon Law", a canonical Lemon Law intake field written through surveyDetails (such as vehicleMake) with HTTP 400 before changes are made: save those intake fields first, then request the status transition separately. Null-valued survey entries are skipped. Unrelated survey fields and empty surveyDetails: {} may accompany leadStatus; other case types retain their existing surveyDetails behavior. Other legacy lead properties retain their existing imperative validation; see docs/api/v1-public-api.md and docs/partner-lemon-law-intake.md for the canonical keys.

caseType
string
description
string
surveyDetails
object

Intake answers keyed by accessor (max 200 keys). Null-valued entries are skipped. Do not duplicate an accessor supplied through lemonLaw, even with the same value.

lemonLaw
object

Optional structured Lemon Law intake. Requires effective caseType "Lemon Law"; PATCH may inherit the stored case type. Supplied fields overwrite canonical survey answers and take precedence over client-derived values. Omitted fields are preserved. Nulls, blanks, unknown fields, and overlapping surveyDetails accessors return HTTP 400. Use surveyDetails for intentional blanks.

{key}
any

Response

{ success: true, lead }

success
boolean
required
{key}
any