Docs
API referenceCompanies

Create a company

Preview· P9
POST
/companies

Free-mail domains are never kept as a company's domain.

Scope: contacts:write

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs above, on any level: it reads the business's reviews and checks every write without saving it
agoo_ck_live_Check API key, live mode, for a Check API partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs above, answering only the published test values, never billed

Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: contacts:write

Header Parameters

Idempotency-Key*string

A UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the original response instead of acting twice. While the first request is still running, a retry returns conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.

Formatuuid

Request Body

application/json
  1. body
name?string
Lengthlength <= 200
other_names?array<string>
Itemsitems <= 20
domains?array<string>

Website domains. A free-mail domain is never kept.

Itemsitems <= 20
phone?string
Lengthlength <= 40
email?string
Lengthlength <= 254
address?
industry?string
Lengthlength <= 80
size_band?string
Value in"1-10""11-50""51-200""201-1000""1000+"
tin?string
Lengthlength <= 40
parent_company_id?string
owner_person_id?string
archived?boolean

Response Body

The company.

application/json
  1. response
id*string
Match^company_[0-7][0-9a-hjkmnp-tv-z]{25}$
name*string
Lengthlength <= 200
domains?array<string>
phone?string
email?string
industry?string
size_band?string
tin?string
parent?
owner?
status*string
Value in"active""archived""merged""erased"
version*integer
Formatint64
curl -X POST 'https://api.agoohq.com/v1/companies' \  -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "name": "string",  "domains": [    "string"  ],  "phone": "string",  "email": "string",  "industry": "string",  "size_band": "string",  "tin": "string",  "parent": {},  "owner": {},  "status": "active",  "version": 0}