curl --request POST \
--url https://api.talkpilot.io/v1/agents/{agentId}/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"salutation": "Herr",
"last_name": "Fey",
"mobile_number": "+491711234567",
"email": "fey@example.com",
"company": "Fey GmbH",
"tags": [
"vip"
]
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_name": "<string>",
"salutation": "Herr",
"first_name": "<string>",
"last_name": "<string>",
"name_parsed": "auto",
"name_source": "ai",
"phone_number": "<string>",
"mobile_number": "<string>",
"landline_number": "<string>",
"email": "jsmith@example.com",
"address": "<string>",
"company": "<string>",
"tags": [
"<string>"
],
"note": "<string>",
"customer_number": 123,
"last_contact_date": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Create a contact
Creates a contact for the agent. Name handling follows the Dashboard:
send salutation/first_name/last_name and customer_name is
composed from them (name_parsed: manual); send only customer_name
and it is split automatically where unambiguous (auto), otherwise the
full name is kept in last_name with name_parsed: unclear — the voice
agent only greets contacts by name when name_parsed is not unclear.
phone_number (the number the agent matches callers against) is derived
from mobile_number (preferred) or landline_number when either is sent.
All numbers must be E.164. name_source is set to manual.
curl --request POST \
--url https://api.talkpilot.io/v1/agents/{agentId}/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"salutation": "Herr",
"last_name": "Fey",
"mobile_number": "+491711234567",
"email": "fey@example.com",
"company": "Fey GmbH",
"tags": [
"vip"
]
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_name": "<string>",
"salutation": "Herr",
"first_name": "<string>",
"last_name": "<string>",
"name_parsed": "auto",
"name_source": "ai",
"phone_number": "<string>",
"mobile_number": "<string>",
"landline_number": "<string>",
"email": "jsmith@example.com",
"address": "<string>",
"company": "<string>",
"tags": [
"<string>"
],
"note": "<string>",
"customer_number": 123,
"last_contact_date": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
API key for external access. Format: tp_live_<32-hex-chars>.
Create keys in the TalkPilot Dashboard under Settings > API.
Path Parameters
Agent UUID
Body
All fields optional. Either send name parts (salutation, first_name,
last_name) or a customer_name to split automatically. Numbers must be
E.164 (+4922112345678); phone_number is derived from
mobile_number/landline_number when either is present.
Only needed when neither mobile_number nor landline_number is sent
Trimmed and de-duplicated; an empty list is stored as null
Response
Contact created
Display name, composed from the parts when they are given
"Herr"
Whether salutation/first_name/last_name are usable for a personal
greeting. manual = parts sent explicitly, auto = split unambiguously
from customer_name, llm = split by the backfill, unclear = not
split (full name kept in last_name) — the voice agent then greets neutrally.
auto, llm, manual, unclear manual = maintained by a person (API or Dashboard); the AI never overwrites such a name
ai, manual Primary number in E.164 — the voice agent matches callers against this and mobile_number
Free tags; an agent's greeting_variants can pick a greeting per tag