User Preferences

Setting a sitewide preference

Changed on
put/v1/user-preferences/site/{propertyName}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/user-preferences/site/{propertyName}
  • Auth
    none declared

Path parameters

propertyNamestring required

The name of the preference.

Request body

propertyValueunknown required

Example request

{
  "propertyValue": true
}

Response

The preference was stored

successboolean required

Example response

{
  "success": true
}

Changes