Skip to main content
PATCH
/
v1
/
leads
/
{id}
Update lead
curl --request PATCH \
  --url https://api.topcalls.ai/v1/leads/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "phone_number": "<string>",
  "email": "jsmith@example.com",
  "status": "New",
  "notes": "<string>",
  "notes_append": "<string>",
  "tags": [
    "<string>"
  ],
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "phone_number": "<string>",
  "status": "New",
  "tags": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "notes": "<string>",
  "metadata": {},
  "converted_at": "2023-11-07T05:31:56Z",
  "list_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.topcalls.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Minimum string length: 1
phone_number
string

Phone number in E.164 format (also validated as dialable by libphonenumber-js — country codes that don't exist are rejected)

Pattern: ^\+[1-9]\d{8,14}$
email
string<email> | null
status
enum<string>
Available options:
New,
Contacted,
Converted,
Unsubscribed
notes
string | null
notes_append
string
tags
string[]
metadata
object

Response

OK

id
string<uuid>
required
account_id
string<uuid>
required
name
string
required
phone_number
string
required
Pattern: ^\+[1-9]\d{8,14}$
status
enum<string>
required
Available options:
New,
Contacted,
Converted,
Unsubscribed
tags
string[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
email
string<email> | null
notes
string | null
metadata
object
converted_at
string<date-time> | null
list_ids
string<uuid>[]