Skip to main content
PATCH
Patch lead
Required scopes: leads.write

Authorizations

Authorization
string
header
required

Use Authorization: Bearer rk_live_....

Headers

Idempotency-Key
string
required

A unique value for each new request, such as a UUID. Send the same value to retry a request safely. The same key and payload replay the first response with Idempotency-Replayed: true.

Required string length: 1 - 160

Path Parameters

lead_id
string
required

Body

application/json
contact_name
string | null
Maximum string length: 200
contact_email
string<email> | null
contact_phone
string | null

US-only phone. Invalid or non-US values return VALIDATION_ERROR.

property_address
string | null

Optional property address. Empty, explicit US country, or US state + ZIP formats are accepted; clearly non-US values return VALIDATION_ERROR.

Maximum string length: 500
form_data
object
custom_fields
object
selected_material_id
string | null
selected_color_id
string | null
selected_shape_id
string | null
status_stage_id
string
attribution
object
marketing_attribution_overrides
object
notes
string | null
Maximum string length: 5000
quote_value

Number or numeric string accepted on write. Serialized responses use number or null.

Required range: 0 <= x <= 10000000
sales_value

Number or numeric string accepted on write. Serialized responses use number or null.

Required range: 0 <= x <= 10000000
follow_up_date
string<date-time> | null

ISO 8601 date-time with Z or a ±HH:MM offset. Stored as UTC.

lead_type
string

Key or current label of a workspace lead type. RoofKit stores the key. When omitted, the current value stays, including an empty one. A sent value replaces the current one. An unknown value returns VALIDATION_ERROR.

Required string length: 1 - 100

Response

Lead updated.

lead
object
required
updated
boolean
required