Skip to main content
PATCH
/
leads
/
{id}
Update Lead
curl --request PATCH \
  --url https://eu-gcp-api.vg-stuff.com/v3/leads/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lead": {
    "email": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "metaData": {
      "address": "<string>",
      "company": "<string>",
      "notes": "<string>",
      "source": "chat"
    },
    "convoId": "<string>",
    "ts": 123
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {}
}

​
Example Request

{
  "lead": {
    "name": "John Smith",
    "metaData": {
      "notes": "Follow up scheduled for next week"
    }
  }
}
Uses partial updates - only provided fields are changed. The ts timestamp is automatically updated.
You cannot change the agentId after creation. Create a new lead if you need to reassign.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The unique identifier of the lead to update

Body

application/json
​
lead
object
required

Lead fields to update

Response

Successful response

​
success
boolean
required

Indicates if the update was successful

​
message
string
required

Response message

​
data
object

Updated lead object