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. The request body chooses which clients to import (all, or the listed external IDs), the client type to give clients the platform gives no company signal for, and whether to enrich eligible companies with Companies House data (excludes Individual, SoleTrader, Trust, Association).
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') |
||
Request Body*
Which clients to import and the import options
{
"externalIds": [
"string"
],
"importAll": false,
"enrichFromCompaniesHouse": false,
"defaultClientType": "PrivateLimitedCompany"
}