Leads

Update a lead

Updates an existing lead in your CRM. Only provided fields will be updated.

patch/leads/{id}

Request

  • Base URL: https://api.heffl.com/api/v1
  • URL: https://api.heffl.com/api/v1/leads/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Lead public ID

Request body

namestring

Lead's full name

mobilestring

Mobile phone number with country code

secondaryMobilestring

Secondary mobile phone number with country code

emailstring email nullable
titlestring

Job title or position

valuenumber

Expected deal value or amount

sourceIdstring

Lead source public ID

stageIdstring

Lead stage public ID

websiteunknown

Response

OK

idstring required

Lead public ID

numberstring required

Auto-generated lead number

namestring required

Full name

titlestring nullable

Job title

emailstring nullable

Email address

mobilestring nullable

Mobile phone number

secondaryMobilestring nullable

Secondary mobile

websitestring nullable

Website URL

valuenumber nullable

Expected value

archivedboolean required

Whether the lead is archived

sourceIdstring nullable

Lead source public ID

stageIdstring nullable

Lead stage public ID

createdAtstring date-time required

When the lead was created

customFieldsobject nullable

Custom field values

Changes

No recorded changes to this operation across all 1 revision of this API.