Update
POST/updateTenant/:tenantGuid
Update a tenant.
Request
Path Parameters
Identifier of the tenant.
- application/json
Body
required
Fields of a tenant to update, omit fields that should remain the same.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
Responses
- 200
- 401
- 422
- 500
The sub-tenants of the API key's tenant.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Whether the request was successful or not.
tenants
object[]
List of sub-tenants of the API key's tenant.
Identifier.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
{
"success": true,
"tenants": [
{
"guid": "TE-1234-1234-1234-1234-1234-1234",
"name": "Tenant A",
"defaultCurrency": "EUR",
"mailSenderName": "Tenant A",
"mailSenderAddress": "[email protected]",
"domain": "tenant-a.example.org"
},
{
"guid": "TE-4321-4321-4321-4321-4321",
"name": "Tenant B",
"defaultCurrency": "EUR",
"mailSenderName": "Tenant B",
"mailSenderAddress": "[email protected]",
"domain": "tenant-b.example.org"
}
]
}
Unauthorized, see authentication.
- application/json
- Schema
- Example (from schema)
- 1000
Schema
1000
- Unauthorized, e.g. invalid credentials1001
- The request is invalid1002
- The value does not comply to the requirements, e.g. pre-defined values1003
- The format is invalid1004
- The value contains invalid characters1005
- Mandatory parameters are missing1006
- Some parameters are not applicable in given request scenario1007
- The provided entity does not exist9999
- Internal system error
true
if successful.
Error code.
Human readable error message.
:::info
While the errorMessage
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the errorCode
field, not the errorMessage
.
:::
{
"success": true,
"errorCode": 1004,
"errorMessage": "name: nameInvalid characters"
}
Unauthorized (1000)
{
"success": false,
"errorCode": 1000,
"errorMessage": "Unauthorized"
}
Unprocessable entity.
- application/json
- Schema
- Example (from schema)
- 1001
Schema
1000
- Unauthorized, e.g. invalid credentials1001
- The request is invalid1002
- The value does not comply to the requirements, e.g. pre-defined values1003
- The format is invalid1004
- The value contains invalid characters1005
- Mandatory parameters are missing1006
- Some parameters are not applicable in given request scenario1007
- The provided entity does not exist9999
- Internal system error
true
if successful.
Error code.
Human readable error message.
:::info
While the errorMessage
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the errorCode
field, not the errorMessage
.
:::
{
"success": true,
"errorCode": 1004,
"errorMessage": "name: nameInvalid characters"
}
Unprocessable entity (1001)
{
"success": false,
"errorCode": 1001,
"errorMessage": "Unauthorized"
}
Internal server error.
- application/json
- Schema
- Example (from schema)
- 1001
Schema
1000
- Unauthorized, e.g. invalid credentials1001
- The request is invalid1002
- The value does not comply to the requirements, e.g. pre-defined values1003
- The format is invalid1004
- The value contains invalid characters1005
- Mandatory parameters are missing1006
- Some parameters are not applicable in given request scenario1007
- The provided entity does not exist9999
- Internal system error
true
if successful.
Error code.
Human readable error message.
:::info
While the errorMessage
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the errorCode
field, not the errorMessage
.
:::
{
"success": true,
"errorCode": 1004,
"errorMessage": "name: nameInvalid characters"
}
Internal server error (9999)
{
"success": false,
"errorCode": 9999,
"errorMessage": "Internal server error"
}