CompanyWhiteLabelSettingsDto
The vendor details the About page and the notification letters print, shared by the whole installation.
| Name | Type | Description | Notes |
|---|---|---|---|
| companyName | String | The vendor name the About page shows and the letters sign off with. Until details are saved it holds whatever the installation ships as its built-in vendor, and it is empty on an installation that ships none. | [required] [example: My Own Corporation] [nullable] |
| site | String | The address the vendor name links to, as an absolute URL with its scheme. Empty under the same conditions as companyName. | [required] [example: https://www.example.com] [nullable] |
| String (email) | The mailbox the About page offers for reaching the vendor. It is not the portal's own support address, and it is empty under the same conditions as companyName. | [required] [example: contact@example.com] [nullable] | |
| address | String | The postal address of the vendor as one free-form line, in the shape it was saved in - no structure is imposed on it. | [required] [example: 123 Business St, New York, NY 10001] [nullable] |
| phone | String | The telephone number of the vendor in the shape it was saved in, with no dialling format enforced. | [required] [example: +1-800-555-0123] [nullable] |
| isLicensor | Boolean | Whether these details are those of the licensor of the product itself rather than of a reseller. Saving through POST api/2.0/settings/rebranding/company always clears it, so only details that came with the installation can report true. | [required] [example: false] |
| hideAbout | Boolean | Whether the About page is hidden from the interface. A plan that does not include branding cannot switch it on: the value is stored as false in that case, so it can come back different from what was saved. | [required] [example: false] |
| isDefault | Boolean | Whether every field above still matches the installation's built-in vendor details. It turns false as soon as one of them is saved differently and true again after DELETE api/2.0/settings/rebranding/company. | [required] [example: true] |