Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Lead & Opportunity

Leads.update

Modifies Lead or Leads with given id(s)

patch/entities/Leads/{id}

Path parameters

idstring uuid required

ID of Lead to update

Query parameters

validation-levelinteger

Specify validation level of Lead on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

createdstring date-time

Creation time.

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to this lead.

descriptionstring

Free-form description of the lead.

is_archivedboolean

True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated.

label_flagstring

User-set colored flag used to highlight the lead in lists and reports.

last_ai_buying_center_appliedstring date-time

Time when an AI-suggested buying center was last applied to this lead.

lead_source_idstring uuid

Id of the lead source.

lead_type_idstring uuid

Id of the lead type.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the lead owner.

quick_account_emailstring

Free-text company email captured at lead creation when no Account record has been linked yet.

quick_account_namestring

Free-text company name captured at lead creation when no Account record has been linked yet.

quick_account_phonestring

Free-text company phone captured at lead creation when no Account record has been linked yet.

quick_contact_namestring

Free-text contact name captured at lead creation when no Contact record has been linked yet.

quick_emailstring

Free-text contact email captured at lead creation when no Contact record has been linked yet.

quick_phonestring

Free-text contact phone captured at lead creation when no Contact record has been linked yet.

rankinginteger

Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead.

reason_of_close_descriptionstring

Free-form note explaining why the lead was archived (lost). Captured alongside reason_of_close.

reason_of_close_idstring uuid

Id of the reason-of-close value.

share_mode0 | 1 | 2 | 3

Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access.

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

step_idstring uuid

Id of the lead process step.

unit_idstring uuid

Id of the sales unit.

revisioninteger

Revision when entity was lastly changed.

lost_datestring date-time

Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived.

Example request

{
  "created": "2019-01-01T00:00:00",
  "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "description": "string",
  "last_ai_buying_center_applied": "2019-01-01T00:00:00",
  "lead_source_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "quick_account_email": "string",
  "quick_account_name": "string",
  "quick_account_phone": "string",
  "quick_contact_name": "string",
  "quick_email": "string",
  "quick_phone": "string",
  "ranking": 1,
  "reason_of_close_description": "string",
  "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
  "step_id": "01234567-abcd-dcba-ffff-000000000000",
  "unit_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1,
  "lost_date": "2019-01-01T00:00:00"
}

Response

Modification confirmation. Returns resulting Lead

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "last_ai_buying_center_applied": "2019-01-01T00:00:00",
    "lead_source_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "quick_account_email": "string",
    "quick_account_name": "string",
    "quick_account_phone": "string",
    "quick_contact_name": "string",
    "quick_email": "string",
    "quick_phone": "string",
    "ranking": 1,
    "reason_of_close_description": "string",
    "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "table_name": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "status": 1,
    "qualify_date": "2019-01-01T00:00:00",
    "days_in_step": 1,
    "lost_date": "2019-01-01T00:00:00",
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}