PATCH
/
api
/
v1
/
user
/
preferences
Updates user preferences.
curl --request PATCH \
  --url https://sdp.suki-stage.com/api/v1/user/preferences \
  --header 'Content-Type: application/json' \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --data '{
  "personalization_preference": {
    "section_format": [
      {
        "loinc": "10164-2",
        "style": "NARRATIVE"
      }
    ],
    "verbosity": "CONCISE"
  }
}'
{
  "preference": {
    "personalization_preference": {
      "section_format": [
        {
          "loinc": "10164-2",
          "style": "NARRATIVE"
        }
      ],
      "verbosity": "CONCISE"
    }
  }
}
Use this endpoint to update some or all of a user’s personalisation preferences. Because this is a PATCH request, you only need to send the fields you want to change.
  • For REST API calls, you do not need to supply a field mask.
  • For gRPC calls, you must include a field mask (update_paths.paths) to specify which fields you are updating.

Headers

sdp_suki_token
string
required

sdp_suki_token

Body

application/json

The request body must be a JSON object containing a preference object. You must provide at least one of the following fields within the personalization_preference object.

User preference settings for personalization

Response

200
application/json

Success Response

Response body for the /user/preferences endpoint