saveGreetingSettings
StringWrapper saveGreetingSettings(GreetingSettingsRequestDto)
POST /api/2.0/settings/greetingsettings
Save the greeting settings
Replaces the greeting title of the current portal with the title from the request, storing it as the portal name. The caller needs the portal-settings right of a DocSpace administrator, otherwise the call is refused. The new caption takes effect at once for every user of the portal and the change is written to the audit trail; repeating the call with the same title leaves the portal in the same state. A missing title or one longer than 255 characters is rejected as an invalid request before the handler runs. On a cloud portal with a free or trial plan the title is also matched against the character rule configured for the installation and a title that breaks it is refused, while a paid cloud plan and a server installation apply no character check. An empty title clears the greeting: the portal falls back to the built-in default caption and GET api/2.0/settings/greetingsettings/isdefault starts answering true. What comes back is a localized confirmation message, not the stored title - read the title with GET api/2.0/settings/greetingsettings.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| GreetingSettingsRequestDto | body | GreetingSettingsRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | A localized message confirming that the greeting title has been saved | StringWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no title, the title is longer than 255 characters, or on a free or trial cloud plan it breaks the character rule of the installation | - | - |
| 403 | The caller has no portal-settings right | - | - |
| 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