---
title: "POST /tenants"
method: POST
path: "/tenants"
tags: ["TenantController"]
---

# POST /tenants

`POST /tenants`

| Permissions |
| ------- |
| 10204   |

## Request body

- NewTenantOnboarding — model describing payload used to create and onboard a tenant (tsType: Omit<TenantOnboardDTO, >, schemaOptions: { title: 'NewTenantOnboarding', exclude: [] })
  - `contact` object — contacts belonging to a tenant (tsType: Omit<Contact, 'tenantId' | 'id'>, schemaOptions: { exclude: [ 'tenantId', 'id' ] })
    - `deleted` boolean
    - `deletedOn` string, date-time, nullable
    - `deletedBy` string, nullable
    - `createdOn` string, date-time
    - `modifiedOn` string, date-time
    - `createdBy` string
    - `modifiedBy` string
    - `name` string, required — name of the contact of a tenant
    - `email` string, required — email id of the contact
    - `isPrimary` boolean, required — boolean value denoting if the contact is a primary contact for it's tenant.
  - `name` string, required
  - `address` string — address of the tenant owners
  - `city` string — city of the tenant owner
  - `state` string — state of the tenant owner
  - `zip` string — zip code of the tenant owner
  - `country` string — country of the tenant owner
  - `key` string, required
  - `domains` string[], required

## Response `200`

Tenant model instance

- Tenant — main model of the service that represents a tenant in the system, either pooled or siloed
  - `deleted` boolean
  - `deletedOn` string, date-time, nullable
  - `deletedBy` string, nullable
  - `createdOn` string, date-time
  - `modifiedOn` string, date-time
  - `createdBy` string
  - `modifiedBy` string
  - `id` string
  - `name` string, required — name of the tenant
  - `status` 0 | 1 | 2 | 3 | 4 | 5, required — status of a tenant, it can be - 0(active), 1(provisioning),2(deprovisioning),3(inactive)
  - `key` string, required — a short string used to identify a tenant. This is also used as the namespace and subdomain for this particular tenant
  - `spocUserId` string — user id of the admin user who acts as a spoc for this tenant.
  - `domains` string[], required
  - `leadId` string — id of the lead from which this tenant was generated. this is optional as a tenant can be created without this lead.
  - `addressId` string — id of the address of the tenant

---

[API](https://skmtc.net/sourcefuse/apis/tenant-mgmt-service.md) · [All operations](https://skmtc.net/sourcefuse/apis/tenant-mgmt-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sourcefuse/tenant-mgmt-service/versions/788b2c08f36d/schema)