Save the mail domain settings

POST /api/2.0/settings/maildomainsettings

Request

Saves the mail domain settings specified in the request to the portal.

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 mail domain settings

typeone of
.enum of string

[None - None, Custom - Custom, All - All]

Can be one of: None, Custom, All.

.enum of integer

[0 - None, 1 - Custom, 2 - All]

Can be one of: 0, 1, 2.

domainsarray of unknown

List of trusted domains

inviteUsersAsVisitorsboolean

Invites as a user or not

Examples

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

{
  "domains": [
    "some text"
  ],
  "inviteUsersAsVisitors": true
}
curl --request POST \
  --url https://example.com/api/2.0/settings/maildomainsettings \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "domains": [
    "some text"
  ],
  "inviteUsersAsVisitors": true
}'

Responses

200

Message about the result of saving the mail domain 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).