Updates user preferences and application settings for a specific user

PUT /api/users/{username}/preferences

• Products: Operator (FOH)
• Features: Front of House Generic Access (FOHGENERIC)

Overview

Sets the avatar and default site of a named staff (back-office) user. Returns 204 No Content with no body. Unlike the endpoints under /api/users/preference/{preferenceId}, which only ever act on the user behind your own access token, this one takes the target user in the path — so use it when an administrator is configuring somebody else's account.

Read the request body table carefully: only details.avatarId and details.preferredSiteId are applied. The whole preferences object — favourites, bookingSheetFavourites, languageId, accessibilitySettings and system — is accepted by the API and then ignored. Sending it changes nothing and returns 204, which is indistinguishable from success. If you need to store those settings, use Creates or updates a user preference for the currently logged-in user, which genuinely saves key/value preferences — subject to its own limitation that it can only write for the caller's own account.

The details object is not optional in practice. Omitting it produces a 500, and supplying it with a blank avatarId produces a 400, so every call must carry an avatar even when all you are changing is the site.

The account must be fully set up for this endpoint or the call returns 404. On numeric-role tenants — those whose users' roleId values are numbers in Retrieves all administrative users configured in the system — this endpoint returns 404 for every account, including accounts that Retrieves detailed information for a specific administrative user returns quite happily. Set avatarId and preferredSiteId through Updates the details and settings for a specific administrative user instead if you hit that.

Endpoint

PUT {base_url}/api/users/{username}/preferences

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Request body

Sample request

curl -X PUT '{base_url}/api/users/{username}/preferences' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "string",
  "preferences": {
    "favourites": "string",
    "bookingSheetFavourites": [
      {
        "id": "string",
        "description": "string"
      }
    ],
    "languageId": "string",
    "accessibilitySettings": {
      "zoomLevel": 1
    },
    "system": {
      "receiptLayoutId": "string",
      "hardwareProfileId": "string"
    }
  },
  "details": {
    "avatarId": "string",
    "preferredSiteId": "string"
  }
}'

Errors

This page as markdown · All pages · llms.txt