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"
]
}Requires scope: leads:write. Body must contain at least one field; notes and notes_append are mutually exclusive.
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.
Use Authorization: Bearer tc_live_xxxxx
1Phone number in E.164 format (also validated as dialable by libphonenumber-js — country codes that don't exist are rejected)
^\+[1-9]\d{8,14}$New, Contacted, Converted, Unsubscribed OK
^\+[1-9]\d{8,14}$New, Contacted, Converted, Unsubscribed