Enable the administrator message settings

POST /api/2.0/settings/messagesettings

Request

Displays the contact form on the "Sign In" page, allowing users to send a message to the DocSpace administrator in case they encounter any issues while accessing DocSpace.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Request parameters for administrator message settings

turnOnboolean

Specifies if the administrator messages are enabled or not

Examples

POST /api/2.0/settings/messagesettings HTTP/1.1
Accept: application/json
Content-Length: 20
Content-Type: application/json
Host: example.com

{
  "turnOn": true
}
curl --request POST \
  --url https://example.com/api/2.0/settings/messagesettings \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "turnOn": true
}'

Responses

200

Message about the result of saving new settings

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).