Create Tenant

Create Tenant

Creates a new tenant from the provided data, associating it within the requester's scope.

Module: Identity

Returns: Master Data → Properties → Tenants → TenantRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Account Permission: ManageTenant (64)

This will be evaluated against your used access token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 45

Identifier of the tenant at its property management company, which isn't necessarily unique.
Usually comes from the ERP system.

string
required
length ≤ 255

Name of the tenant.

string | null

Name of the recipient contractors address their invoices for this tenant to.

string | null

c/o line of the invoice address.

string | null

Street and house number of the invoice address.

string | null

Postal code of the invoice address.

string | null

City of the invoice address.

boolean
required

Whether the tenant is hidden.
facilioo leaves hidden tenants out of its views for property managers by default, and parties of type User can't access them at all.
The API still returns them to property managers unless you filter with hidden set to false.

string | null

External ID of the tenant, unique among the tenants of the owner party.
More info: External IDs

Headers
string
Defaults to en-DE

Language preference header. Allowed languages: German (en-DE).

string
Defaults to 2.0

API version to use (1 or 2) either with trailing .0 or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).

Responses

401

Error: Unauthorized

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json