Skip to main content
PATCH
Update Lead
Updates fields on an existing lead record.

Stage update behavior

Unlike lead creation (which accepts stage_name), updating a lead’s stage requires providing the target stage ID in stage_id.

Path parameters

  • id (string, required): The unique identifier of the lead to update.

Required permissions

Requires an API key with the crm:write scope.

Authorizations

x-api-key
string
header
required

Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.

Path Parameters

id
string
required

The unique identifier of the lead

Body

application/json

Fields to update on an existing lead. Note that updates accept stage_id rather than stage_name.

name
string
Example:

"Acme Corp - Expanded Deal"

email
string<email>
Example:

"lead@acmecorp.com"

phone
string
Example:

"+15559876543"

stage_id
string

Stage ID to transition this lead into

Example:

"stage_proposal_sent"

assigned_to
string
Example:

"user_michael"

tags
string[]
Example:
custom_fields
object
Example:

Response

Lead updated successfully

Standard envelope returned by POST, PATCH, PUT, and DELETE (mutation) endpoints

success
boolean
required
Example:

true

data
object
required

The created or updated entity

error
null
required
Example:

null