saveWhiteLabelLogoText
BooleanWrapper saveWhiteLabelLogoText(isDark, isDefault, WhiteLabelRequestDto)
POST /api/2.0/settings/whitelabel/logotext/save
Save the white label logo text
Sets the wordmark that the portal prints next to or instead of a logo image, on the login page, in the editors and in notification letters. Only logoText from the request body is used here, and it is limited to 40 characters; a longer value is rejected as an invalid request. Sending an empty or blank text, or exactly the built-in ONLYOFFICE, clears the setting instead of storing it, which has the same effect as PUT api/2.0/settings/whitelabel/logotext/restore. Requires a DocSpace administrator and a plan that includes customization, which GET api/2.0/settings/enablewhitelabel reports; otherwise the call is refused as payment required. The call is mutating and idempotent: the previous text is overwritten and true comes back. Logo images are not touched - they are saved by POST api/2.0/settings/whitelabel/logos/save - and the text is not rendered into them. Pass isDefault=true to write the installation-wide default wordmark instead of this portal's, which only a server installation allows. Read the stored value back with GET api/2.0/settings/whitelabel/logotext.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| isDark | query | Boolean | Which theme the answer is filled in for: true fills the dark image only, false the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image. | [optional] [example: true] |
| isDefault | query | Boolean | Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403. | [optional] [example: true] |
| WhiteLabelRequestDto | body | WhiteLabelRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | Always true once the logo text has been stored for the portal | BooleanWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The logoText is longer than 40 characters | - | - |
| 402 | The portal's pricing plan has no customization option, or the branding section is switched off in the installation | - | - |
| 403 | The caller is not a DocSpace administrator, or the installation does not allow default branding to be edited | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json