Clients

Create clients in batch

post

This method allows you to create one or more clients at the same time.

Authorizations

PublicApiKey

x-api-keystringRequired

Header parameters

x-tenant-idstring · uuidOptional

Tenant id (uuid v4)

Body

application/json

Responses

201Success

application/json

idstringRequired

Unique identifier of the created client

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e

external_client_idobject · nullableRequired

External client identifier

Example: 123456

namestringRequired

Client name

Example: Client name

phoneobject · nullableRequired

Client's phone number

Example: 937-99-92

emailobject · nullableRequired

Client's email

Example: [email protected]

companyobject · nullableRequired

Client's company name

Example: Client company

429

Returned when the rate limit is exceeded

post

/api/v1/public/clients/batch

HTTPcURLJavaScriptPython

POST /api/v1/public/clients/batch HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "clients": [
    {
      "name": "Client name",
      "external_client_id": "123456",
      "phone": "937-99-92",
      "email": "[email protected]",
      "company": "Client company"
    }
  ]
}

[
  {
    "id": "b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e",
    "external_client_id": "123456",
    "name": "Client name",
    "phone": "937-99-92",
    "email": "[email protected]",
    "company": "Client company"
  }
]