Helpdesk Email Settings

Get

Retrieve the help desk email settings

GET/api/HelpdeskEmailSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

helpDeskEnabledboolean

Whether Help Desk is Enabled or not

helpDeskEmailnullable string

Help Desk Email.

Request

JavaScriptCurlPython

const response = await fetch('/api/HelpdeskEmailSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "helpDeskEnabled": false,
  "helpDeskEmail": "text"
}

Update

Modify Help Desk Email Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/HelpdeskEmailSettings

Query parameters

Body

application/json; api-version=1.0

Help Desk Email Settings

apLockboolean

siteIdinteger (int32)

The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

helpdeskEnablednullable boolean

Whether RAS Helpdesk is enabled.

helpdeskEmailnullable string

RAS Helpdesk email.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/HelpdeskEmailSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}