Sign in

v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Post Contacts

Create a new contact.

Adds a contact record to the CRM. Only name is required; all other fields are optional. Contacts typically represent qualified individuals (e.g., converted from a lead).

Request Body (ContactRequest):

  • name (required): Full name of the contact.
  • email (optional): Email address (stored as primary email).
  • phone (optional): Phone number (stored as primary phone).
  • source (default: "Unknown"): Marketing source. Values: Google, Facebook, Youtube, Reddit, Snapchat, Craigslist, Yelp, Linkedin, Incoming-Call, SMS, Referral, Bing, Yahoo, Nextdoor, Unknown, TikTok, Instagram, Billboard Ad.
  • status (default: "assigned"): Contact status. Values: open, assigned, attempted, contacted, meeting-setup, disqualified, incorrect.
  • comments, tags, employer_name, profession, title, ssn, website, birth_year, birth_month, birth_day, decision_date, business_need_description, social_dict_list (optional): Same as lead fields.

Response: The created contact object.

post/crm/contacts

Request body

namestring required
emailstring nullable
sourcestring nullable

Possible values: Google, Facebook, Youtube, Reddit, Snapchat, Craigslist, Yelp, Linkedin, Incoming-Call, SMS, Referral, Bing, Yahoo, Nextdoor, Unknown, TikTok, Instagram, Billboard Ad

phonestring nullable
commentsstring nullable
statusstring nullable

Possible values: open, assigned, attempted, contacted, meeting-setup, disqualified, incorrect

tagsstring[] nullable

List of tags (maximum 10 tags allowed)

employer_namestring nullable

Company name

professionstring nullable

Occupation

titlestring nullable

Title, indexed for search

ssnstring nullable

SSN - encrypted at rest (format: XXX-XX-XXXX or XXXXXXXXX)

websitestring nullable

URL, maps to vCard

birth_yearinteger nullable

4-digit year (e.g., 1985)

birth_monthinteger nullable

Birth month 1-12

birth_dayinteger nullable

Birth day 1-31

decision_dateinteger nullable

Unix epoch timestamp (seconds)

business_need_descriptionstring nullable

Free text for business need

social_dict_listobject[] nullable

List of social profiles, e.g. [{"type": "linkedin", "url": "https://linkedin.com/in/..."}]

Response

Successful Response

idstring required
first_namestring nullable required
last_namestring nullable required
namestring required
statusstring required
marketing_sourcestring nullable
created_datestring nullable required
updated_datestring nullable required
status_updated_datestring nullable required
tagsstring[] nullable
social_dict_listobject[] nullable