Skip to contentSkip to navigation

Update Lead

Update an existing lead. Only provided fields are changed.

PATCH /api/v1/leads/{lead_id}

Path Parameters

lead_id string path required

The unique identifier of the lead.

Request Body

All fields are optional. Only include the fields you want to update.

email string body

New email address. Must be unique within the workspace.

firstName string body

First name.

lastName string body

Last name.

company string body

Company name.

title string body

Job title.

phone string body

Phone number.

linkedinUrl string body

LinkedIn profile URL.

website string body

Website URL.

customFields object body

Custom key-value fields (replaces entire object).

notes string body

Freeform notes.

interestStatus string | null body

interested, not_interested or out_of_office; null clears it. A value set here stays until a reply that arrives after it is categorized. It does not change who can be mailed.

status string body

Lead status.

Errors

StatusDescription
404Lead not found
409A lead with the new email already exists in the workspace

Rate Limit

  • 120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Was this page helpful?