Sign in
Leads

Update Lead

patch/api/v1.0/leads/{id}

Path parameters

idstring required

The ID for the lead

Request body

actioned_atnumber

The date/time the last time a Lead was updated at represented as an integer

addressstring

The address of the Lead (auto-generated if latitude/longitude are specified)

amountnumber

Estimated value of the Lead

campaign_idinteger

The ID of the Campaign the Lead was created on

created_atnumber

The date/time the Lead was created at represented as an integer

custom_fieldsobject

A dictionary of Custom Field values with keys matching the Lead's Campaign Custom Field IDs

descriptionstring

A text description for the Lead

disable_webhooksboolean

Condition for deciding whether to disable webhook for the Lead

idstring

The ID of the Lead

identifierstring

The name of the Lead, never null (if the Leads name is empty, it will provide a default string for the Lead)

latitudenumber

The latitude coordinate for the Lead's location

longitudenumber

The longitude coordinate for the Lead's location

namestring

The name of the Lead

owner_idsinteger[]

The array of IDs of Users who own the Lead

photo_urlsstring

An array of urls set associated with the Lead

recording_urlstring

A url to a mp3 file for a recorded description

status'fresh' | 'received_by_sales' | 'work_in_progress' | 'pending_decision' | 'contract_signed' | 'completed' | 'failed' | 'hibernated'

The current status of the Lead in the Wingmate CRM Pipeline | OneOf("fresh", "received_by_sales", "work_in_progress", "pending_decision", "contract_signed", "completed", "failed", "hibernated")

status_stringstring

The name of the status matching the Campaign's lead_statuses field

worker_idinteger

The ID of the user who generated the Lead

Response

Success

Changes

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