Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Leads

Update lead

Update the metadata or referrer information on an existing lead record.

Required permissions:

  • lead:manage
  • member:email:read
  • access_pass:basic:read
  • member:basic:read
patch/leads/{id}

Path parameters

idstring required
Example:lead_xxxxxxxxxxxxx

The unique identifier of the lead to update, starting with 'lead_'.

Request body

metadataobject nullable

A JSON object of custom metadata to set on the lead, replacing any existing metadata.

referrerstring nullable

The updated referral URL for the lead, such as 'https://example.com/landing'.

Response

A successful response

created_atstring date-time required

The datetime the lead was created.

idstring required

The unique identifier for the lead.

metadataobject nullable required

Custom key-value pairs attached to this lead. Null if no metadata was provided.

referrerstring nullable required

The URL of the page that referred this lead to the company. Null if no referrer was captured.

updated_atstring date-time required

The datetime the lead was last updated.

Example response

{
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "lead_xxxxxxxxxxxxx",
  "product": {
    "id": "prod_xxxxxxxxxxxxx",
    "title": "Pickaxe Analytics"
  },
  "referrer": "https://twitter.com/whabormarket",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "user": {
    "email": "john.doe@example.com",
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}