UpdateTenantRequest
A full replacement of the tenant's own details, as the settings page edits them. Counts, the logo, the
verification state and the owner are not part of it (they have their own resources or are read-only).
Properties
| Name | Type | Description |
|---|---|---|
| name* | string | The tenant's name |
The tenant's name | ||
| address | TenantAddressDto | The postal address |
The postal address | ||
| phoneNumber | string | The phone number |
The phone number | ||
| emailAddress | string | The tenant's email address. Changing it un-verifies it and sends a verification email to the new address. |
The tenant's email address. Changing it un-verifies it and sends a verification email to the new address. | ||
| isVatRegistered* | boolean | Whether the tenant is VAT registered |
Whether the tenant is VAT registered | ||
| vatRegistrationNumber | string | The VAT registration number |
The VAT registration number | ||
| shareDetailsDefault* | boolean | Whether new subcontractors default to sharing their details |
Whether new subcontractors default to sharing their details | ||
| isSupportAccessEnabled* | boolean | Whether CIS Manager support agents may access the tenant |
Whether CIS Manager support agents may access the tenant | ||
| modules* | array of enum | The modules the tenant uses: CisContractor, CisSubcontractor or both |
The modules the tenant uses: CisContractor, CisSubcontractor or both | ||
JSON Example
{
"name": "string",
"address": {
"line1": "string",
"line2": "string",
"line3": "string"
},
"phoneNumber": "string",
"emailAddress": "user@example.com",
"isVatRegistered": false,
"shareDetailsDefault": false,
"isSupportAccessEnabled": false,
"modules": [
"CisContractor"
]
}