Skip to main content
POST
Create a Contact

Body

application/json

Request body for creating a contact via POST or upserting via PUT.

Custom fields can be passed as additional keys prefixed with custom_field_.

email
string | null

Email address of the contact. Either email or linkedin_url is required.

Example:

"jane@acme.com"

linkedin_url
string | null

LinkedIn profile URL. Either email or linkedin_url is required.

Example:

"https://linkedin.com/in/janesmith"

first_name
string | null

First name of the contact

Example:

"Jane"

last_name
string | null

Last name of the contact

Example:

"Smith"

title
string | null

Job title of the contact

Example:

"VP of Engineering"

phone_number
string | null

Phone number of the contact

Example:

"+1-555-123-4567"

location
string | null

Location of the contact

Example:

"San Francisco, CA"

account_id
string<uuid> | null

ID of the account to associate the contact with

domain
string | null

Domain of the contact's company (used for account resolution)

Example:

"acme.com"

do_not_contact
boolean | null

Whether the contact has opted out of outreach

tags
string<uuid>[] | null

List of tag IDs to associate with the contact

Response

Successful Response

data
ContactResponse · object
required

Contact resource. Custom fields appear as additional keys prefixed with custom_field_.

meta
ResponseMeta · object