Import clients from a third-party connection
Imports clients from the third-party platform. This endpoint uses a hybrid approach: it queues the import job and waits up to 10 seconds for completion. For small imports (5-20 clients), the job typically completes within this window and returns 201 Created with the final result. For larger imports that take longer, it returns 202 Accepted with a Location header pointing to the import job status endpoint. If importAll query parameter is true, imports all available clients and ignores the request body. Otherwise, imports only the clients specified by external IDs in the request body. If enrichFromCompaniesHouse is true, enriches UK private limited companies with Companies House data.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| connectionCode* | query string | The code of the third-party connection to import from (e.g., 'xero-abc123') |
The code of the third-party connection to import from (e.g., 'xero-abc123') |
||
| enrichFromCompaniesHouse | query boolean | When true, enriches newly imported UK private limited companies with Companies House data (business details, key dates, officer contacts). Only applies to clients with Type=PrivateLimitedCompany. Default: false. |
When true, enriches newly imported UK private limited companies with Companies House data (business details, key dates, officer contacts). Only applies to clients with Type=PrivateLimitedCompany. Default: false. |
||
| importAll | query boolean | When true, imports all available clients from the platform and ignores the request body. When false (default), only imports clients specified by ExternalIds in the request body. |
When true, imports all available clients from the platform and ignores the request body. When false (default), only imports clients specified by ExternalIds in the request body. |
||
Request Body*
Request body containing external IDs to import
{
"externalIds": [
"string"
]
}