Skip to main content
POST
Provision a tenant

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Provisioning and user management need the pulse.write scope; reads need pulse.read.

Body

application/json
parent_tenant_id
string<uuid>
required
name
string
required
trial
boolean
required
short_name
null | string
kind
null | string
contact
null | string
notification_email
null | string
address_1
null | string
address_2
null | string
city
null | string
state
null | string
postal_code
null | string
country_id
region_id
industry_id
employee_count
assigned_technician_user_id
null | string<uuid>
tenant_kind_id
legacy_use_type
support_enabled
null | boolean
idempotency_key
null | string

Response

OK

tenant_id
string<uuid>
required
tenant_number
required
job_id
string<uuid>
required
status
string
required
tenant_host
string
required
registration_key
null | string
required
orchestrator_wake_succeeded
null | boolean
required