API Docs / Operations / Tenants / Import Tenant Data

Import Tenant Data

POST /tenants/{tenant}/import

Creates the contacts in a data-config JSON file (multipart/form-data, field 'file'), skipping codes that already exist unless skipExisting=false. A file that is not a data-config document is 400.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

skipExisting query boolean

Request Body*

multipart/form-data •
{
  "file": "string"
}

Responses

204 No Content
400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
404 Not Found
application/problem+json