getWhiteLabelLogoText
StringWrapper getWhiteLabelLogoText(isDark, isDefault)
GET /api/2.0/settings/whitelabel/logotext
Get the white label logo text
Returns the wordmark the current portal prints next to or instead of a logo image, as a bare string rather than an object. Requires a DocSpace administrator, because this is the settings view of the value; the branding a login page needs is served by GET api/2.0/settings/whitelabel/logos, which needs no authentication. The call is read-only and idempotent. When nothing has been stored for the portal, the built-in ONLYOFFICE is returned, so the answer is never empty and cannot be used to tell a custom text from the default one - GET api/2.0/settings/whitelabel/logotext/isdefault answers that question. Pass isDefault=true to read the installation-wide default wordmark instead of this portal's; without it the portal's own value is returned even when the installation carries a different default. Change the text with POST api/2.0/settings/whitelabel/logotext/save and clear it with PUT api/2.0/settings/whitelabel/logotext/restore. The value is stored as it was typed, at most 40 characters long, and is not translated for the caller's language, so the same wordmark is returned for every user of the portal.
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] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The wordmark stored for the portal, or the built-in ONLYOFFICE when none is set | StringWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 403 | The caller has no portal-settings right | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 400 | Bad Request. | 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: Not defined
- Accept: application/json