This guide is for those who want your Copilot workspace to use multi-company clients who also created their API connections prior to August 7, 2025. If you were using our API prior to August 7, you’ll need to update some your API properties with the following new properties.

How To Use This Guide

  1. Check your API connections for any of the endpoints or properties in the following Core Resource types listed below.
  2. Replace references of the old properties to the new properties.
  3. Check the new behavior of certain endpoints to see that they behave as intended with new changes.
  4. Refer to our API Reference if you need specific guidance on each Core Resource type.

App Connections

What’s changing: You now need to provide a value for companyId in the request body when creating an app connection.

Endpoint name New behavior
Create app connection companyId is now required when creating individual/group connections for clients. This is automatically set if clients have only 1 company.

Contracts

What’s changing: recipientId is now broken down into clientId and companyId . If you referenced recipientId in any Contract related endpoint or web-hook, you will now need to reference clientId and companyId .

Deprecated property New properties
recipientId `clientId

companyId` |

Endpoint name New behavior
Create Provide a value for clientId and companyId in the request body when creating an contract instead of recipientId. Providing an empty companyId will return an error if the client is part of more than one company.
List When listing contracts use the clientId query param instead of recipientId

Invoices & Subscriptions

What’s changing: recipientId is now broken down into clientId and companyId . If you referenced recipientId in any Invoice/Subscription related endpoint or web-hook, you will now need to reference clientId and companyId .

Deprecated property New properties
recipientId clientId
companyId
Endpoint name New behavior
Create Provide a value for clientId and companyId in the request body when creating an invoice or subscription instead of recipientId.

Providing an empty companyId will return an error if the client is part of more than one company. |

Forms

What’s changing: both clientId and companyId are now required in each item.

Endpoint name New behavior
Request Form Response Provide a value for clientCompanyIds which includes both client and company IDs in the request body when sharing a form instead of clientIds.