Create/Update a contact

cURL

curl --request POST \
  --url http://sandbox.mintlify.com/core/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "email": "<string>",
      "name": "<string>",
      "other_email": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "preferred_name": "<string>",
      "honorific": "<string>",
      "title": "<string>",
      "role": "<string>",
      "seniority": "<string>",
      "bio": "<string>",
      "description": "<string>",
      "avatar_url": "<string>",
      "birth_date": "<string>",
      "phone": "<string>",
      "other_phone": "<string>",
      "home_phone": "<string>",
      "mobile_phone": "<string>",
      "linkedin_handle": "<string>",
      "twitter_handle": "<string>",
      "facebook_handle": "<string>",
      "instagram_handle": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "company_name": "<string>",
      "company_website": "<string>",
      "company_industry": "<string>",
      "company_employee_count": "<string>",
      "company_revenue": "<string>",
      "company_sector": "<string>",
      "company_phone": "<string>",
      "company_description": "<string>",
      "company_location": "<string>",
      "company_timezone": "<string>",
      "company_twitter_handle": "<string>",
      "company_linkedin_handle": "<string>",
      "company_avatar_url": "<string>",
      "company_is_icp": true,
      "company_tech": [
        "<string>"
      ],
      "lead_source": "<string>",
      "lead_score": 123,
      "domain": "<string>",
      "source": "<string>",
      "type": "<string>",
      "form": "<string>",
      "play": "<string>",
      "traffic_source": "<string>",
      "last_seen": "<string>",
      "visits": 123,
      "chats": 123,
      "meetings": 123,
      "persona": "<string>",
      "custom_fields": {},
      "enriched_fields": [
        "<string>"
      ],
      "enriched_timestamp": "<string>"
    }
  }
}
'

{
  "data": {
    "attributes": {
      "email": "<string>",
      "name": "<string>",
      "other_email": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "preferred_name": "<string>",
      "honorific": "<string>",
      "title": "<string>",
      "role": "<string>",
      "seniority": "<string>",
      "bio": "<string>",
      "description": "<string>",
      "avatar_url": "<string>",
      "birth_date": "<string>",
      "phone": "<string>",
      "other_phone": "<string>",
      "home_phone": "<string>",
      "mobile_phone": "<string>",
      "linkedin_handle": "<string>",
      "twitter_handle": "<string>",
      "facebook_handle": "<string>",
      "instagram_handle": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "company_name": "<string>",
      "company_website": "<string>",
      "company_industry": "<string>",
      "company_employee_count": "<string>",
      "company_revenue": "<string>",
      "company_sector": "<string>",
      "company_phone": "<string>",
      "company_description": "<string>",
      "company_location": "<string>",
      "company_timezone": "<string>",
      "company_twitter_handle": "<string>",
      "company_linkedin_handle": "<string>",
      "company_avatar_url": "<string>",
      "company_is_icp": true,
      "company_tech": [
        "<string>"
      ],
      "lead_source": "<string>",
      "lead_score": 123,
      "domain": "<string>",
      "source": "<string>",
      "type": "<string>",
      "form": "<string>",
      "play": "<string>",
      "traffic_source": "<string>",
      "last_seen": "<string>",
      "visits": 123,
      "chats": 123,
      "meetings": 123,
      "persona": "<string>",
      "custom_fields": {},
      "enriched_fields": [
        "<string>"
      ],
      "enriched_timestamp": "<string>"
    }
  }
}

POST

core

contact

cURL

curl --request POST \
  --url http://sandbox.mintlify.com/core/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "email": "<string>",
      "name": "<string>",
      "other_email": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "preferred_name": "<string>",
      "honorific": "<string>",
      "title": "<string>",
      "role": "<string>",
      "seniority": "<string>",
      "bio": "<string>",
      "description": "<string>",
      "avatar_url": "<string>",
      "birth_date": "<string>",
      "phone": "<string>",
      "other_phone": "<string>",
      "home_phone": "<string>",
      "mobile_phone": "<string>",
      "linkedin_handle": "<string>",
      "twitter_handle": "<string>",
      "facebook_handle": "<string>",
      "instagram_handle": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "company_name": "<string>",
      "company_website": "<string>",
      "company_industry": "<string>",
      "company_employee_count": "<string>",
      "company_revenue": "<string>",
      "company_sector": "<string>",
      "company_phone": "<string>",
      "company_description": "<string>",
      "company_location": "<string>",
      "company_timezone": "<string>",
      "company_twitter_handle": "<string>",
      "company_linkedin_handle": "<string>",
      "company_avatar_url": "<string>",
      "company_is_icp": true,
      "company_tech": [
        "<string>"
      ],
      "lead_source": "<string>",
      "lead_score": 123,
      "domain": "<string>",
      "source": "<string>",
      "type": "<string>",
      "form": "<string>",
      "play": "<string>",
      "traffic_source": "<string>",
      "last_seen": "<string>",
      "visits": 123,
      "chats": 123,
      "meetings": 123,
      "persona": "<string>",
      "custom_fields": {},
      "enriched_fields": [
        "<string>"
      ],
      "enriched_timestamp": "<string>"
    }
  }
}
'

{
  "data": {
    "attributes": {
      "email": "<string>",
      "name": "<string>",
      "other_email": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "preferred_name": "<string>",
      "honorific": "<string>",
      "title": "<string>",
      "role": "<string>",
      "seniority": "<string>",
      "bio": "<string>",
      "description": "<string>",
      "avatar_url": "<string>",
      "birth_date": "<string>",
      "phone": "<string>",
      "other_phone": "<string>",
      "home_phone": "<string>",
      "mobile_phone": "<string>",
      "linkedin_handle": "<string>",
      "twitter_handle": "<string>",
      "facebook_handle": "<string>",
      "instagram_handle": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "company_name": "<string>",
      "company_website": "<string>",
      "company_industry": "<string>",
      "company_employee_count": "<string>",
      "company_revenue": "<string>",
      "company_sector": "<string>",
      "company_phone": "<string>",
      "company_description": "<string>",
      "company_location": "<string>",
      "company_timezone": "<string>",
      "company_twitter_handle": "<string>",
      "company_linkedin_handle": "<string>",
      "company_avatar_url": "<string>",
      "company_is_icp": true,
      "company_tech": [
        "<string>"
      ],
      "lead_source": "<string>",
      "lead_score": 123,
      "domain": "<string>",
      "source": "<string>",
      "type": "<string>",
      "form": "<string>",
      "play": "<string>",
      "traffic_source": "<string>",
      "last_seen": "<string>",
      "visits": 123,
      "chats": 123,
      "meetings": 123,
      "persona": "<string>",
      "custom_fields": {},
      "enriched_fields": [
        "<string>"
      ],
      "enriched_timestamp": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Contact information

data

object

required

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.email

string

required

The contact's primary email address

data.attributes.name

string

The contact's full name

data.attributes.other_email

string

The contact's secondary email address

data.attributes.first_name

string

The contact's first name

data.attributes.middle_name

string

The contact's middle name

data.attributes.last_name

string

The contact's last name

data.attributes.preferred_name

string

The contact's preferred name

data.attributes.honorific

string

The contact's honorific (e.g., Mr., Mrs., Dr.)

data.attributes.title

string

The contact's job title

data.attributes.role

string

The contact's role in the organization

data.attributes.seniority

string

The contact's seniority level

data.attributes.bio

string

The contact's biography

data.attributes.description

string

Additional description of the contact

data.attributes.avatar_url

string

URL to the contact's avatar image

data.attributes.birth_date

string

The contact's birth date

data.attributes.phone

string

The contact's primary phone number

data.attributes.other_phone

string

The contact's secondary phone number

data.attributes.home_phone

string

The contact's home phone number

data.attributes.mobile_phone

string

The contact's mobile phone number

data.attributes.linkedin_handle

string

The contact's LinkedIn handle

data.attributes.twitter_handle

string

The contact's Twitter handle

data.attributes.facebook_handle

string

The contact's Facebook handle

data.attributes.instagram_handle

string

The contact's Instagram handle

data.attributes.city

string

The contact's city

data.attributes.state

string

The contact's state

data.attributes.country

string

The contact's country

data.attributes.company_name

string

The name of the contact's company

data.attributes.company_website

string

The contact's company website

data.attributes.company_industry

string

The contact's company industry

data.attributes.company_employee_count

string

The contact's company employee count

data.attributes.company_revenue

string

The contact's company revenue

data.attributes.company_sector

string

The contact's company sector

data.attributes.company_phone

string

The contact's company phone number

data.attributes.company_description

string

Description of the contact's company

data.attributes.company_location

string

Location of the contact's company

data.attributes.company_timezone

string

Timezone of the contact's company

data.attributes.company_twitter_handle

string

Twitter handle of the contact's company

data.attributes.company_linkedin_handle

string

LinkedIn handle of the contact's company

data.attributes.company_avatar_url

string

URL to the company's avatar image

data.attributes.company_is_icp

boolean

Whether the company is an Ideal Customer Profile (ICP)

data.attributes.company_tech

string[]

Array of technologies used by the company

data.attributes.lead_source

string

Source of the lead

data.attributes.lead_score

integer

Score of the lead

data.attributes.domain

string

Domain associated with the contact

data.attributes.source

string

Source of the contact

data.attributes.type

string

Type of the contact

data.attributes.form

string

Form associated with the contact

data.attributes.play

string

Play associated with the contact

data.attributes.traffic_source

string

Source of traffic

data.attributes.last_seen

string

Last time the contact was seen

data.attributes.visits

integer

Number of visits

data.attributes.chats

integer

Number of chats

data.attributes.meetings

integer

Number of meetings

data.attributes.persona

string

Persona associated with the contact

data.attributes.custom_fields

object

Custom fields associated with the contact

data.attributes.enriched_fields

string[]

Array of enriched fields

data.attributes.enriched_timestamp

string

Timestamp of enrichment

Response

Contact created or updated successfully

data

object

required

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.email

string

required

The contact's primary email address

data.attributes.name

string

The contact's full name

data.attributes.other_email

string

The contact's secondary email address

data.attributes.first_name

string

The contact's first name

data.attributes.middle_name

string

The contact's middle name

data.attributes.last_name

string

The contact's last name

data.attributes.preferred_name

string

The contact's preferred name

data.attributes.honorific

string

The contact's honorific (e.g., Mr., Mrs., Dr.)

data.attributes.title

string

The contact's job title

data.attributes.role

string

The contact's role in the organization

data.attributes.seniority

string

The contact's seniority level

data.attributes.bio

string

The contact's biography

data.attributes.description

string

Additional description of the contact

data.attributes.avatar_url

string

URL to the contact's avatar image

data.attributes.birth_date

string

The contact's birth date

data.attributes.phone

string

The contact's primary phone number

data.attributes.other_phone

string

The contact's secondary phone number

data.attributes.home_phone

string

The contact's home phone number

data.attributes.mobile_phone

string

The contact's mobile phone number

data.attributes.linkedin_handle

string

The contact's LinkedIn handle

data.attributes.twitter_handle

string

The contact's Twitter handle

data.attributes.facebook_handle

string

The contact's Facebook handle

data.attributes.instagram_handle

string

The contact's Instagram handle

data.attributes.city

string

The contact's city

data.attributes.state

string

The contact's state

data.attributes.country

string

The contact's country

data.attributes.company_name

string

The name of the contact's company

data.attributes.company_website

string

The contact's company website

data.attributes.company_industry

string

The contact's company industry

data.attributes.company_employee_count

string

The contact's company employee count

data.attributes.company_revenue

string

The contact's company revenue

data.attributes.company_sector

string

The contact's company sector

data.attributes.company_phone

string

The contact's company phone number

data.attributes.company_description

string

Description of the contact's company

data.attributes.company_location

string

Location of the contact's company

data.attributes.company_timezone

string

Timezone of the contact's company

data.attributes.company_twitter_handle

string

Twitter handle of the contact's company

data.attributes.company_linkedin_handle

string

LinkedIn handle of the contact's company

data.attributes.company_avatar_url

string

URL to the company's avatar image

data.attributes.company_is_icp

boolean

Whether the company is an Ideal Customer Profile (ICP)

data.attributes.company_tech

string[]

Array of technologies used by the company

data.attributes.lead_source

string

Source of the lead

data.attributes.lead_score

integer

Score of the lead

data.attributes.domain

string

Domain associated with the contact

data.attributes.source

string

Source of the contact

data.attributes.type

string

Type of the contact

data.attributes.form

string

Form associated with the contact

data.attributes.play

string

Play associated with the contact

data.attributes.traffic_source

string

Source of traffic

data.attributes.last_seen

string

Last time the contact was seen

data.attributes.visits

integer

Number of visits

data.attributes.chats

integer

Number of chats

data.attributes.meetings

integer

Number of meetings

data.attributes.persona

string

Persona associated with the contact

data.attributes.custom_fields

object

Custom fields associated with the contact

data.attributes.enriched_fields

string[]

Array of enriched fields

data.attributes.enriched_timestamp

string

Timestamp of enrichment

Introduction Schedule a Meeting

⌘I

API Reference

Contact

Meeting

Phone Call

Create/Update a contact

Authorizations

Body

Response