Skip to main content
POST
Add clients to a company

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Company ID

Query Parameters

confirmPromotePlaceholder
boolean

Promote a placeholder company when adding clients

Body

application/json

Clients to add

clientIds
string[]
required

ClientIDs are the IDs of the clients to add to the company. At least one ID is required.

Minimum array length: 1

Response

OK

addClientErrors
object[]

AddClientErrors lists the clients that could not be added, with the reason for each.

addedClientIds
string[]

AddedClientIDs are the IDs of the clients successfully added to the company.