Add Contact

Adds a new contact to the system

post/v1/add-contact

Request body

external_contact_idstring required

Your unique internal identifier for the contact

external_urlstring uri

External URL linking to the contact in your CRM or external system

salutationstring

Formal title or greeting (e.g. 'Mr.', 'Ms.', 'Herr', 'Frau'). If empty, will auto guess based on first name for German calls.

first_namestring required
last_namestring required
phone_numberstring required

Contact's phone number in E.164 format (e.g. +4917642048466)

emailstring email
contact_detailsobject

Custom variables passed to the AI agent (should be discussed in advance). Please send variables in lowercase snake_case. This used to be called dynamic_variables, which still works but is deprecated and should be replaced with contact_details. Alternatively, you can send contact_details_<key> in the body instead of an object.

timezonestring

IANA timezone identifier (e.g. Europe/Berlin). Defaults to account timezone if not set

Response

Contact created successfully

contact_idstring uuid

Changes

No recorded changes to this endpoint across all 1 revision of this API.