Update member personalisation

PUT /api/members/{memberId}/personalisation/{personalisationID}

Success: 204 No content

• Products: Operator (FOH), Consumer (CONSUMER) (any one of these products, not all)
• Features: Online Bookings (ONLINEBOOK), Online Joining (ONLINEJOIN), Front of House Generic Access (FOHGENERIC) (any one of these features, not all)

Overview

Changes the value of one personalisation record on a member. A personalisation record is a typed preference held against the member, addressed by a type key.

In practice Language is the only type this endpoint accepts. Every other key is rejected with 400 even when the key exists in the tenant's personalisation type list, because only Language is supported.

Two behaviours are worth knowing before you build against it:

• An unrecognised language is not an error. If the value you send is not in the tenant's allowed-languages configuration, en-GB is silently substituted and the call reports success. Read the record back if you need to know what was actually stored.
• The record must already exist. This endpoint only overwrites; it will not create a personalisation record for a member who has none, and returns 404 or 400 in that case rather than creating one.

The member id in the route must match the member id in your access token. Linked members are explicitly not accepted here, unlike most member endpoints — a primary member cannot set a linked member's personalisation, and attempting it returns 403.

Endpoint

PUT {base_url}/api/members/{memberId}/personalisation/{personalisationID}

{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/members/{memberId}/personalisation/{personalisationID}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true' \
  -H 'Content-Type: application/json' \
  -d '{
  "typeKey": "Language",
  "value": "en-GB"
}'

Response fields

A successful call returns 204 No Content with an empty body — none of the fields below is sent. They describe the personalisation record as you will see it when you read it back. Read the record back if you need the stored value, particularly after sending a language that may have been substituted.

Sample response

{
  "id": 12345,
  "typeId": 12345,
  "typeKey": "string",
  "value": "string"
}

Errors

This page as markdown · All pages · llms.txt