Companies

Update company

Use the Update company endpoint to update both the name and description of the company. If you use groups to manage a set of companies, use the Add company or Remove company endpoints to add or remove a company from a group.

A company represents a business sharing access to their data. Each company can have multiple connections to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.

put/companies/{companyId}

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

Request body

namestring required

Name of company being connected.

descriptionDescription — unresolved $ref
groupsItems[] — unresolved $ref

Reference to the groups that the company is assigned to.

Response

OK

Company required— unresolved $ref

Changes