Skip to main content
PUT
Update a business lead record and status

Path Parameters

id
string
required

The ID of the lead to update.

Body

The updated lead data.

Request schema for the Leadping API lead request, including the fields clients can send.

metadata
object

Structured metadata used for attribution, integrations, and reporting on this lead request.

contact
object

Contact details for the lead or customer represented by this lead request.

customer
object

Demographic profile details for the lead represented by this lead request.

enabled
boolean | null

Indicates whether this lead request is active and available in the Leadping API.

tagIds
string[]

Tag IDs assigned to or filtered against this lead.

tagNames
string[]

Tag names assigned to this lead when matching existing tags by name.

id
string | null

The unique identifier for the entity, when updating an existing entity.

Response

Lead was successfully updated.

Response schema for the Leadping API lead response returned to authenticated clients.

metadata
object

Structured metadata used for attribution, integrations, and reporting on this lead response.

contact
object

Contact details for the lead or customer represented by this lead response.

phoneIdentity
object | null

Canonical phone identity and provider lookup details for this lead.

customer
object

Demographic profile details for the lead represented by this lead response.

enabled
boolean

Indicates whether this lead response is active and available in the Leadping API.

archivedAt
string<date-time> | null

UTC timestamp when this record was archived.

archivedByUserId
string | null

User ID of the person who archived this record.

archiveReason
enum<integer> | null

Defines why a lead was removed from the active working pipeline.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
archiveNote
string | null

Optional note explaining why the lead was archived.

isArchived
boolean

Indicates whether the lead has been archived in Leadping.

currentDisposition
object | null

Current disposition summary that describes the lead outcome.

tags
object[]

Tags currently attached to this lead, source, or record.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.