Create a client company

Create a client company attached to your reseller account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Example payload

name, trial_end and company_setting.license_category are required. trial_end is a Unix timestamp in seconds: the company starts a Leexi trial until that date, or is created with an ended trial when the date is in the past.

{
    "name": "New Client",
    "reseller_external_id": "CLIENT-9",
    "trial_end": 1767222000,
    "company_setting": { "license_category": "business" },
    "setting": { "locale": "fr-FR", "time_zone": "Europe/Paris" }
}

The company is created under your reseller account with its settings and the license you choose among free, starter, ai_meeting and business: an unknown or missing license answers 422, and so does an unknown subscription_interval, subscription_currency, setting.locale or setting.time_zone. It has no team yet: create one with the client teams endpoints before adding users.

📘

Requires the write_clients permission scope on the API key of a reseller account.

❗️

reseller_external_id must be unique among your client companies: a duplicate answers 409.

Body Params
company_setting
object
required
string

Industry of the client company.

string
required

Name of the client company. Must not contain # or _.

string

Your own reference for this client company. Must be unique among your client companies.

setting
object
string

Billing currency, for example eur. Locked while a Stripe subscription is active.

string
enum

Billing interval, month or year.

Allowed:
integer
required

End of the Leexi trial as a Unix timestamp (seconds). Required. A date in the past creates the company with an ended trial.

Responses

401

401

402

402

429

429

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json