BackOffice ERPInstall

Summary

Update an existing lead record by specifying its Lead Id and new data fields to modify.

Inputs

• Lead Id (required) — Exact lead ID number or a name/keyword for smart search to identify the lead to update.
• Source (required) — Lead source information.
• Status (required) — Lead status value.
• Name (required) — Lead's name.
• Assigned (required) — Person or entity assigned to the lead.
• Client id — Associated client identifier; supports smart search by name, email, or keyword.
• Tags — Tags associated with the lead.
• Contact — Contact information for the lead.
• Title — Lead's position or title.
• Email — Email address of the lead.
• Website — Lead's website URL.
• Phone Number — Phone number of the lead.
• Company — Company associated with the lead.
• Address — Physical address of the lead.
• City — City of the lead's address.
• State — State of the lead's address.
• Country — Country of the lead's address.
• Default language — Default language setting for the lead.
• Description — Description or notes about the lead.
• Lastcontact — Timestamp or date of last contact with the lead.
• Is public — Flag or identifier indicating public visibility, noted as 'Lead google sheet id'.

Output shape

a single record representing the updated lead data or an error description if the update fails

Handles smart search for Lead Id by name, email, or keyword to locate the lead. Returns multiple match warnings if ambiguous. Requires valid credentials and correct base URL configuration. Throws detailed errors if required fields are missing or IDs not resolved. Supports partial updates via optional properties.

Examples

Example 1: Update lead with ID or smart search term

Provide Lead Id (or a name/keyword for auto-resolving), then specify required fields: Source, Status, Name, Assigned. Include optional fields to update relevant lead details like Contact, Email, Website, etc.