API referenceCompanies
Update a company
Preview· P9
PATCH
Names the version it read.
Scope: contacts:write
header
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers 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 mode | As above, in test mode |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As 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 partner | Your servers only: the Checks operations (checks:read), billed per check |
agoo_ck_test_ | Check API key, test mode | As 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
company_id*stringMatch
^company_[0-7][0-9a-hjkmnp-tv-z]{25}$version?integerThe version you read. A stale one is 409.
Format
int64Range
1 <= valueapplication/json- body
name?stringLength
length <= 200other_names?array<string>Items
items <= 20domains?array<string>Website domains. A free-mail domain is never kept.
Items
items <= 20phone?stringLength
length <= 40email?stringLength
length <= 254address?industry?stringLength
length <= 80size_band?stringValue in
"1-10""11-50""51-200""201-1000""1000+"tin?stringLength
length <= 40parent_company_id?stringowner_person_id?stringarchived?booleanThe company.
application/json- response
id*stringMatch
^company_[0-7][0-9a-hjkmnp-tv-z]{25}$name*stringLength
length <= 200domains?array<string>phone?stringemail?stringindustry?stringsize_band?stringtin?stringparent?owner?status*stringValue in
"active""archived""merged""erased"version*integerFormat
int64curl -X PATCH 'https://api.agoohq.com/v1/companies/string' \ -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}