Save the additional white label settings

POST /api/2.0/settings/rebranding/additional

Request

Saves the additional white label settings specified in the request.

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

Additional white label settings

settingsobject

startDocsEnabledboolean

Specifies if the start document is enabled or not

helpCenterEnabledboolean

Specifies if the help center is enabled or not

feedbackAndSupportEnabledboolean

Specifies if feedback and support are available or not

feedbackAndSupportUrlstring

Feedback and support URL

userForumEnabledboolean

Specifies if the user forum is enabled or not

userForumUrlstring

User forum URL

videoGuidesEnabledboolean

Specifies if the video guides are enabled or not

videoGuidesUrlstring

Video guides URL

salesEmailstring

Sales email

buyUrlstring

URL to pay for the portal

licenseAgreementsEnabledboolean

Specifies if the license agreements are enabled or not

licenseAgreementsUrlstring

License agreements URL

Examples

POST /api/2.0/settings/rebranding/additional HTTP/1.1
Accept: application/json
Content-Length: 431
Content-Type: application/json
Host: example.com

{
  "settings": {
    "startDocsEnabled": true,
    "helpCenterEnabled": true,
    "feedbackAndSupportEnabled": true,
    "feedbackAndSupportUrl": "some text",
    "userForumEnabled": true,
    "userForumUrl": "some text",
    "videoGuidesEnabled": true,
    "videoGuidesUrl": "some text",
    "salesEmail": "some text",
    "buyUrl": "some text",
    "licenseAgreementsEnabled": true,
    "licenseAgreementsUrl": "some text"
  }
}

curl --request POST \
  --url https://example.com/api/2.0/settings/rebranding/additional \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "settings": {
    "startDocsEnabled": true,
    "helpCenterEnabled": true,
    "feedbackAndSupportEnabled": true,
    "feedbackAndSupportUrl": "some text",
    "userForumEnabled": true,
    "userForumUrl": "some text",
    "videoGuidesEnabled": true,
    "videoGuidesUrl": "some text",
    "salesEmail": "some text",
    "buyUrl": "some text",
    "licenseAgreementsEnabled": true,
    "licenseAgreementsUrl": "some text"
  }
}'

Responses

200

Boolean value: true if the operation is successful

400

Settings is empty

401

Unauthorized

403

No permissions to perform this action