Skip to main content
PUT
Update a tenant
Send every value you want the tenant to keep, including name. A value you leave out can be cleared, and status can go back to active. Read the tenant with Get a tenant and send it back with your changes.
The logo cannot be changed after the tenant is created.

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.

tenantId
string
required

Identifier of the tenant to update.

Body

application/json
name
string

Name of the tenant.

description
string

Description of the tenant.

status
string

active or inactive.

Not used. The logo cannot be changed after the tenant is created.

contactPerson
object

Contact person of the tenant.

identifier
string

Your own identifier for the tenant.

Response

The updated 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.