Clients

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

Body

application/json

externalIdstringRequired

client's external id

namestringRequired

client's name

callSignstringRequired

client's call sign

descriptionstringRequired

client's description

typestring · enum | nullableOptional

client's type (optional): if not provided semantic default is client, parent client must have type parent

Possible values:

parentClientExternalIdstring | nullableOptional

parent client's external id (optional)

Responses

201Success

post

/api/v1/customers/{customerId}/clients/import

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/clients/import HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "externalId": "text",
  "name": "text",
  "callSign": "text",
  "description": "text",
  "type": "client",
  "parentClientExternalId": "text"
}

201Success

No content

post

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

Query parameters

isInitialbooleanOptional

Body

application/json

Responses

201Success

post

/api/v1/customers/{customerId}/clients/batch

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/clients/batch HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "clients": [
    {
      "externalId": "text",
      "name": "text",
      "callSign": "text",
      "description": "text",
      "type": "client",
      "parentClientExternalId": "text"
    }
  ]
}

201Success

No content