For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
An array of company update payloads. Each payload must include the ‘company_id’ to identify the company and can include any other fields that need to be updated. The ‘timestamp’ field should represent the time of update.
company_idstringRequired>=1 character
Unique external identifier of the company entity, ID stored in your database / back-office
timestampdatetimeRequired
When this company record was created or last modified in your system, in ISO 8601 format.
is_test_companybooleanRequiredDefaults to false
If the company is a test company, this should be set to true
account_statusenumOptional
The account status for the related person at that timestamp. Refer to the Developer Guide "Entity Account Statuses" to understand what account statuses mean at Cable, and how to use them
Allowed values:
legal_namestringOptional
Legal name of the business
trading_namestringOptional
Trading name of the business
emailstringOptional
Main contact email for the company
addresseslist of objectsOptional
phone_numberstringOptional
Main contact telephone number for the company
typestringOptional
Business entity type. eg. Sole Trader, Limited Company
