v1

latestOpenAPI 3.1.02026-08-069158174.8 KB

CRM Service Calls

Patch Lead

Update an existing lead by ID.

Send only the fields you want to change. Unset fields are left unchanged. Returns 400 if no fields are provided.

Path Parameters:

lead_id: The lead's CRM record ID.

Request Body (LeadUpdateRequest): Same fields as POST /leads, but all optional. Only the fields you include will be updated.

Response: The updated lead object.

patch/crm/leads/{lead_id}

Path parameters

lead_idstring required

Request body

namestring nullable

emailstring nullable

sourcestring nullable

Possible values: Google, Facebook, Youtube, Reddit, Snapchat, Craigslist, Yelp, Linkedin, Incoming-Call, SMS, Referral, Bing, Yahoo, Nextdoor, Unknown, TikTok, Instagram, Billboard Ad

phonestring nullable

commentsstring nullable

statusstring nullable

Possible values: open, assigned, attempted, contacted, meeting-setup, disqualified, incorrect

tagsstring[] nullable

List of tags (maximum 10 tags allowed)

employer_namestring nullable

Company name

professionstring nullable

Occupation

titlestring nullable

Title, indexed for search

ssnstring nullable

SSN - encrypted at rest (format: XXX-XX-XXXX or XXXXXXXXX)

websitestring nullable

URL, maps to vCard

birth_yearinteger nullable

4-digit year (e.g., 1985)

birth_monthinteger nullable

Birth month 1-12

birth_dayinteger nullable

Birth day 1-31

decision_dateinteger nullable

Unix epoch timestamp (seconds)

business_need_descriptionstring nullable

Free text for business need

social_dict_listobject[] nullable

List of social profiles, e.g. [{"type": "linkedin", "url": "https://linkedin.com/in/..."}]

Response

Successful Response

idstring required

first_namestring nullable required

last_namestring nullable required

namestring required

statusstring required

marketing_sourcestring nullable

created_datestring nullable required

updated_datestring nullable required

status_updated_datestring nullable required

tagsstring[] nullable

social_dict_listobject[] nullable

is_convertedboolean

Whether lead has been converted to contact

contact_idstring nullable

Contact ID if converted

has_dealboolean

Whether a deal/opportunity exists

deal_stagestring nullable

Current deal stage if exists

deal_idstring nullable

Deal/Opportunity ID if exists

value_of_salenumber nullable

Value of sale for the deal if exists

close_datestring nullable

Close date of the deal in ISO 8601 format