Complete the Wizard settings

PUT /api/2.0/settings/wizard/complete

Request

Completes the Wizard settings.

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

Wizard settings request parameters

emailstringformat: email

Email

passwordHashstring

Password hash

lngstring

Language

timeZonestring

Time zone

amiIdstring

AMI ID

subscribeFromSiteboolean

Subscribed from the site or not

Examples

PUT /api/2.0/settings/wizard/complete HTTP/1.1
Accept: application/json
Content-Length: 176
Content-Type: application/json
Host: example.com

{
  "email": "Lorna_Simonis2@hotmail.com",
  "passwordHash": "some text",
  "lng": "some text",
  "timeZone": "some text",
  "amiId": "some text",
  "subscribeFromSite": true
}
curl --request PUT \
  --url https://example.com/api/2.0/settings/wizard/complete \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "Lorna_Simonis2@hotmail.com",
  "passwordHash": "some text",
  "lng": "some text",
  "timeZone": "some text",
  "amiId": "some text",
  "subscribeFromSite": true
}'

Responses

200

Wizard settings

completedboolean

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).