v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Post Accounts

Create a new account (company/organization).

Only name is required. Defaults: source="Unknown", status="customer", relationship_type="customer".

Request Body (AccountRequest):

  • name (required): Account name.
  • email, phone (optional): Primary contact info.
  • source (default: "Unknown"): Marketing source.
  • status (default: "customer"): Values: open, assigned, attempted, contacted, meeting-setup, customer, lost-followup, lost, inactive, incorrect, disqualified, prospect, ex-customer.
  • relationship_type (default: "customer"): Values: customer, vendor, partner, prospect, other.
  • tags (optional): Up to 10 tags.
  • website, company_name, description, industry, num_employees (optional).
  • social_dict_list (optional): Social profiles, e.g. [{"type": "linkedin", "url": "..."}].

Response: The created account object.

post/crm/accounts

Request body

namestring required

Account name

emailstring nullable
phonestring nullable
sourcestring nullable

Marketing source, e.g. Google, Facebook, Referral, Unknown

statusstring nullable

Possible values: open, assigned, attempted, contacted, meeting-setup, customer, lost-followup, lost, inactive, incorrect, disqualified, prospect, ex-customer

relationship_type'customer' | 'vendor' | 'partner' | 'prospect' | 'other' nullable

Possible values: customer, vendor, partner, prospect, other

tagsstring[] nullable

List of tags (maximum 10 tags allowed)

websitestring nullable

Company website URL

company_namestring nullable

Company display name

descriptionstring nullable

Account description / notes

industrystring nullable

Industry sector, e.g. technology, healthcare, other

num_employeesinteger nullable

Number of employees

social_dict_listobject[] nullable

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

Response

Successful Response

idstring required
namestring required
statusstring nullable
sourcestring nullable
relationship_typestring nullable
websitestring nullable
company_namestring nullable
descriptionstring nullable
industrystring nullable
num_employeesinteger nullable
tagsstring[] nullable
social_dict_listobject[] nullable
created_datestring nullable
updated_datestring nullable