Skip to main content

​
Contacts

Contacts represent the people your agents will call. Each contact can have associated metadata that gets injected into conversations.

​
What is a Contact?

A contact stores:
  • Basic Info - Name, phone number, email
  • Metadata - Custom fields relevant to your use case
  • History - Previous conversations with this contact

​
Contact Properties

PropertyDescription
idUnique identifier (UUID)
workspaceIdThe workspace this contact belongs to
firstNameContact’s first name
lastNameContact’s last name
phonePhone number in E.164 format
emailEmail address
metadataCustom JSON object with additional data
createdAtWhen the contact was created
updatedAtWhen the contact was last modified

​
Phone Number Format

All phone numbers must be in E.164 format: 
+[country code][subscriber number]

+14155551234

​
Using Metadata

Metadata lets you store custom data that can be used in agent conversations: 
{
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+14155551234",
  "metadata": {
    "accountNumber": "AC-12345",
    "preferredLanguage": "Spanish",
    "lastPurchaseDate": "2024-01-15",
    "vipStatus": true
  }
}
These values can be referenced in your agent’s system prompt using {{variableName}} syntax.

​
API Operations