Update Lead

Update an existing lead. All fields are optional.

Authentication

X-API-Keystring
Your API key from [Dashboard → Settings → API Keys](https://dashboard.bookedin.ai/settings)

Path parameters

lead_idstringRequired

Request

This endpoint expects an object.
contactobjectOptional
Lead contact information
sourceenumOptionalDefaults to API
metamap from strings to anyOptional
Custom metadata fields
pipeline_idstringOptional
Assign lead to a pipeline
list_idstringOptional
Assign lead to a list

Response

Lead updated
idstringOptional
Unique lead identifier
business_idstringOptional
Business this lead belongs to
contactobjectOptional
Lead contact information
sourceenumOptional
How this lead was created
metamap from strings to anyOptional
Custom metadata fields. Store any additional data about the lead.
dataobjectOptional
Lead status and scoring data
pipeline_idstringOptional
Pipeline this lead is assigned to
pipeline_stageobjectOptional
Current pipeline stage information
created_atdatetimeOptional

Errors

404
Not Found Error