Skip to content
DonorIntel Knowledge Base

Provision Tenant

POST
/v1/tenants/

Manually provision a new tenant. Platform superadmin only. The corresponding WorkOS organization must already exist — provide its org ID. Tenant creation via first-login JIT or WorkOS webhook is still the normal path; this endpoint exists for cases where an operator needs to pre-provision an account (e.g. migrating a customer, enterprise contract setup).

Request Body required

Section titled “Request Body required ”
TenantCreate

Fields required to onboard a new Tenant (typically triggered by WorkOS org creation webhook).

object
workos_org_id
required
Workos Org Id
string
name
required
Name
string
>= 1 characters <= 255 characters
slug
required
Slug
string
>= 1 characters <= 100 characters /^[a-z0-9-]+$/
plan_name
Plan Name
string
default: essentials
primary_contact_name
required
Primary Contact Name
string
>= 1 characters <= 255 characters
primary_contact_email
required
Primary Contact Email
string format: email
primary_contact_phone
required
Primary Contact Phone
string
>= 1 characters <= 50 characters
mailing_address_line_1
required
Mailing Address Line 1
string
>= 1 characters <= 255 characters
mailing_address_line_2
Mailing Address Line 2
string
"" <= 255 characters
mailing_city
required
Mailing City
string
>= 1 characters <= 100 characters
mailing_state
required
Mailing State
string
>= 1 characters <= 100 characters
mailing_zipcode
required
Mailing Zipcode
string
>= 1 characters <= 20 characters
mailing_country
required
Mailing Country
string
>= 1 characters <= 100 characters
is_active
Is Active
boolean
default: true

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Response[TenantRead]
object
data
required
TenantRead

Full representation of a Tenant record.

object
id
required
Id
string format: uuid
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
workos_org_id
required
Workos Org Id
string
name
required
Name
string
slug
required
Slug
string
plan_name
required
Plan Name
string
primary_contact_name
required
Primary Contact Name
string
primary_contact_email
required
Primary Contact Email
string
primary_contact_phone
required
Primary Contact Phone
string
mailing_address_line_1
required
Mailing Address Line 1
string
mailing_address_line_2
required
Mailing Address Line 2
string
mailing_city
required
Mailing City
string
mailing_state
required
Mailing State
string
mailing_zipcode
required
Mailing Zipcode
string
mailing_country
required
Mailing Country
string
is_active
required
Is Active
boolean
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object