API Docs / Schemas / TenantUpdateRequest

TenantUpdateRequest

Request DTO for updating a tenant

Properties

Name Type Description
name*string

The human-readable name of the tenant

The human-readable name of the tenant

accountingConnectionCodestring

The code of the accounting connection to use for this tenant
To clear it, set to an empty string rather than null.

The code of the accounting connection to use for this tenant
To clear it, set to an empty string rather than null.

directDebitConnectionCodestring

The code of the direct debit connection to use for this tenant
To clear it, set to an empty string rather than null.

The code of the direct debit connection to use for this tenant
To clear it, set to an empty string rather than null.

amlConnectionCodestring

The code of the AML connection to use for this tenant
To clear it, set to an empty string rather than null.

The code of the AML connection to use for this tenant
To clear it, set to an empty string rather than null.

documentStorageConnectionCodestring

The code of the document storage connection to use for this tenant
To clear it, set to an empty string rather than null.

The code of the document storage connection to use for this tenant
To clear it, set to an empty string rather than null.

autoCreateClientFoldersboolean

Whether Sodium automatically creates subfolders for each client under the document storage base folder.
Only applicable when an external document storage provider is connected.
When false, users must manually map each client to a pre-existing folder.
If null, the existing value will not be changed.

Whether Sodium automatically creates subfolders for each client under the document storage base folder.
Only applicable when an external document storage provider is connected.
When false, users must manually map each client to a pre-existing folder.
If null, the existing value will not be changed.

isSupportAccessEnabledboolean

Whether support access is enabled for this tenant.
If null, the existing value will not be changed.

Whether support access is enabled for this tenant.
If null, the existing value will not be changed.

JSON Example

{
  "name": "string",
  "accountingConnectionCode": "string",
  "directDebitConnectionCode": "string",
  "amlConnectionCode": "string",
  "documentStorageConnectionCode": "string"
}

Used By Operations