Skip to main content
POST
Create a tenant
Only name is required. The response is 200, not 201, and holds the new tenant. The tenant belongs to the building in the path.
A tenant is what you assign to spaces with Create a space assignment. The logo can be set only now. It cannot be changed later.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId
string
required

Building identifier from List buildings.

Body

application/json
name
string
required

Name of the tenant. Required.

Pattern: \S
description
string

Description of the tenant.

status
string

active or inactive.

Logo of the tenant. You can set it only when you create the tenant.

contactPerson
object

Contact person of the tenant.

identifier
string

Your own identifier for the tenant.

Response

The created tenant.

_id
string

Tenant identifier.

organizationId
string
createdAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

updatedAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

name
string

Name of the tenant.

description
string
type
string

Type of the tenant, for example company.

status
string

active or inactive.

buildingIds
string[]

Buildings the tenant belongs to.

identifier
string

Your own identifier for the tenant.

Logo of the tenant.

contactPerson
object

Contact person of the tenant.