Create Company

Create a company. Users and contacts whose email is on one of its email domains join it.

POST /api/v1/crm/companies

Create Company

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/crm/companies \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "website": "<string>",
  "industry": "<string>",
  "size": "<string>",
  "country": "<string>",
  "lifecycle_stage": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "csm_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "arr": "<string>",
  "currency": "<string>",
  "plan": "<string>",
  "contract_start_date": "<string>",
  "renewal_date": "<string>",
  "custom_fields": {},
  "email_domains": [
    "<string>"
  ]
}
'

201

{}

Authorizations

X-API-Key · string · header · required

Body

application/json

name · string · required

description · string | null

website · string | null

industry · string | null

size · string | null

'', 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000 or 5000+

country · string | null

lifecycle_stage · string | null

'', prospect, onboarding, customer or churned

owner_id · string<uuid> | null

Account owner (sales), an active staff user; null clears it

csm_id · string<uuid> | null

Customer success manager, an active staff user; null clears it

arr · string number

Annual recurring revenue; null clears it

currency · string | null

ISO 4217 code of arr, e.g. EUR

plan · string | null

contract_start_date · string | null

YYYY-MM-DD

renewal_date · string | null

YYYY-MM-DD; renewal deals open ahead of it

custom_fields · Custom Fields · object | null

Merged into the record; null value clears a key

email_domains · string[] | null

Replaces the company's email domains

Response

201 - application/json

Created

The response is of type Response · object.