Contact data model

A contact represents a person that optionally is associated with a call

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for this contact object
created_atstring (date-time)NoThe date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the contact
first_namestringNo
last_namestringNo
titlestringNoThe job title of the contact
companystringNoThe company/organization name of the contact
emailsUcEmail[]NoAn array of email addresses for this contact
emails[].emailstringYes
emails[].typeenumNoValues: WORK, HOME, OTHER
telephonesUcTelephone[]NoAn array of telephones for this contact
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE

TypeScript

TypeScript
export type UcContact = {
	id?: string; // Unique identifier for this contact object
	created_at?: string-time; // The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The name of the contact
	first_name?: string;
	last_name?: string;
	title?: string; // The job title of the contact
	company?: string; // The company/organization name  of the contact
	emails?: []; // An array of email addresses for this contact
	telephones?: []; // An array of telephones for this contact
	raw?: any; // The raw data returned by the integration for this contact
} 

Zod

Zod
import { z } from 'zod';

export const ZodUcContact = z.object({
	id: z.string().optional().describe("Unique identifier for this contact object"),
	created_at: z.string-time().optional().describe("The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The name of the contact"),
	first_name: z.string().optional(),
	last_name: z.string().optional(),
	title: z.string().optional().describe("The job title of the contact"),
	company: z.string().optional().describe("The company/organization name  of the contact"),
	emails: z.array().optional().describe("An array of email addresses for this contact"),
	telephones: z.array().optional().describe("An array of telephones for this contact"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class UcContact:
	"""Unique identifier for this contact object"""
	id: Optional[str]
	"""The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The name of the contact"""
	name: Optional[str]
	first_name: Optional[str]
	last_name: Optional[str]
	"""The job title of the contact"""
	title: Optional[str]
	"""The company/organization name  of the contact"""
	company: Optional[str]
	"""An array of email addresses for this contact"""
	emails: Optional[PropertyUcContactEmails]
	"""An array of telephones for this contact"""
	telephones: Optional[PropertyUcContactTelephones]
Are we missing anything? Let us know
Was this page helpful?