Sign in
User Preferences

Setting a sitewide preference

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

Path parameters

propertyNamestring required

The name of the preference.

Request body

{"stackTrail":"paths:/v1/user-preferences/site/{propertyName}:put:requestBody:content:application/json:schema:properties:propertyValue","oasType":"schema","type":"unknown","description":"The preference to be stored. It may be of any json-serializable type."}

Example request

{
  "propertyValue": true
}

Response

The preference was stored

successboolean required

Example response

{
  "success": true
}

Changes

Changed in 4 of the 55 revisions of this API.44

  • 022694254f0d1See the full diff
    • ○

      api operation id setSiteUserPreference was added

      api-operation-id-added

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status

      response-non-success-status-removed

  • 9d8cc5bc6b432See the full diff
    • ▲

      the request's body type changed from any to no type

      request-body-type-changed

    • ▲

      the request property type changed from any to no type

      request-property-type-changed

  • e8c2858fd4eb22See the full diff
    • ▲

      the request's body type changed from no type to any

      request-body-type-changed

    • ▲

      the request property type changed from no type to any

      request-property-type-changed

    • ○

      api operation id setSiteUserPreference removed and replaced with

      api-operation-id-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog