PATCH
/
tenants
/
{id}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

Tenant identifier

Body

The updated Tenant resource
​
name
string
required

The name of the tenant

Required string length: 2 - 255
​
legalCompanyName
string
required
​
commercialRegister
string | null
required
​
commercialRegisterNumber
string | null
required
​
vatNumber
string | null
​
city
string
​
zip
string
​
street
string
​
housenumber
string
​
countryCode
string
​
website
string | null
​
phone
string | null
​
email
string
​
ceo
string | null
​
iban
string

The IBAN will be displayed on the invoice

​
appearance
object | null
​
documentSettings
object | null
​
readOnlyCustomers
boolean

If true, customers are read-only in the frontend

Response

200
application/json
Tenant resource updated
​
name
string
required

The name of the tenant

Required string length: 2 - 255
​
legalCompanyName
string
required
​
commercialRegister
string | null
required
​
commercialRegisterNumber
string | null
required
​
id
string
​
username
string
​
vatNumber
string | null
​
owner
any
​
city
string
​
zip
string
​
street
string
​
housenumber
string
​
countryCode
string
​
website
string | null
​
phone
string | null
​
email
string
​
ceo
string | null
​
iban
string

The IBAN will be displayed on the invoice

​
environment
enum<string>
Available options:
sandbox,
production
​
appearance
object | null
​
documentSettings
object | null
​
timeZone
string
default:
Europe/Berlin
​
readOnlyCustomers
boolean

If true, customers are read-only in the frontend

​
createdAt
string

The date and time when the resource was created.

​
updatedAt
string

The date and time when the resource was last updated.

Was this page helpful?

Get a tenantGet the tenants of the current user