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"
}

Contacts

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.

POST

/

v1

/

agents

/

{agentId}

/

contacts

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

X-API-Key

string

header

required

API key for external access. Format: tp_live_<32-hex-chars>. Create keys in the TalkPilot Dashboard under Settings > API.

Path Parameters

agentId

string<uuid>

required

Agent UUID

Body

application/json

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.

customer_name

string | null

salutation

string | null

first_name

string | null

last_name

string | null

phone_number

string | null

Only needed when neither mobile_number nor landline_number is sent

mobile_number

string | null

landline_number

string | null

email

string<email> | null

address

string | null

company

string | null

tags

string[] | null

Trimmed and de-duplicated; an empty list is stored as null

note

string | null

customer_number

number | null

last_contact_date

string<date-time> | null

Response

Contact created

id

string<uuid>

agent_id

string<uuid>

read-only

customer_name

string | null

Display name, composed from the parts when they are given

salutation

string | null

Example:

"Herr"

first_name

string | null

last_name

string | null

name_parsed

enum<string>

read-only

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.

Available options:

auto,

llm,

manual,

unclear

name_source

enum<string>

read-only

manual = maintained by a person (API or Dashboard); the AI never overwrites such a name

Available options:

ai,

manual

phone_number

string | null

Primary number in E.164 — the voice agent matches callers against this and mobile_number

mobile_number

string | null

landline_number

string | null

email

string<email> | null

address

string | null

company

string | null

tags

string[] | null

Free tags; an agent's greeting_variants can pick a greeting per tag

note

string | null

customer_number

number | null

last_contact_date

string<date-time> | null

created_at

string<date-time>

updated_at

string<date-time>