API ReferenceContacts

Create contact

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Request

This endpoint expects an object.
namestringRequired

Full name of the contact (1-255 characters)

primaryPhonestringRequired
Primary phone number in E.164 format
addressobject or nullOptional
Contact address structure
companystring or nullOptional
Company or organization name
emailstring or nullOptional
Email address
interestslist of strings or nullOptional

Contact interests or topics (max 50)

languagestring or nullOptional

BCP 47 language code (2-10 characters)

notesstring or nullOptional

Free-text notes (max 5000 characters)

occupationstring or nullOptional
Job title or occupation
secondaryPhoneslist of strings or nullOptional

Additional phone numbers in E.164 format (max 10)

tagslist of strings or nullOptional

Tags for categorization (max 50)

timezonestring or nullOptional
IANA timezone identifier

Response

Contact created
accountIdstringformat: "uuid"
Account that owns this contact
addressobject

Structured address (street, city, state, zip, country)

createdAtdatetime
Timestamp when the contact was created
idstringformat: "uuid"
Unique identifier for the contact
interestslist of strings
Contact interests or topics
languagestring
BCP 47 language code
namestring
Full name of the contact
primaryPhonestring
Primary phone number in E.164 format
secondaryPhoneslist of strings
Additional phone numbers in E.164 format
tagslist of strings
Tags for categorization and filtering
updatedAtdatetime
Timestamp when the contact was last updated
companystring or nullOptional
Company or organization name
deletedAtdatetime or nullOptional

Timestamp when the contact was soft-deleted, if applicable

emailstring or nullOptional
Email address
lastContactedAtdatetime or nullOptional
Timestamp of the most recent call with this contact
notesstring or nullOptional

Free-text notes about the contact

occupationstring or nullOptional
Job title or occupation
timezonestring or nullOptional
IANA timezone identifier

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error