Sign in

v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB
/api/v1/user/preferences

Update user preferences

Updates personalization preferences for the authenticated user, such as note verbosity and section format. Settings apply to future sessions for that user. Send only the fields you want to change.

patch/api/v1/user/preferences

Headers

sdp_provider_idstring
Example:provider-123

Optional for standard partners.

Required for:

  • Bearer authentication. Use the same provider_id returned by the Login or Register API.
  • Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Request body

Example request

{
  "personalization_preference": {
    "section_format": [
      {
        "loinc": "10164-2",
        "style": "NARRATIVE"
      }
    ],
    "verbosity": "CONCISE"
  }
}

Response

Request succeeded.

Example response

{
  "preference": {
    "personalization_preference": {
      "section_format": [
        {
          "loinc": "10164-2",
          "style": "NARRATIVE"
        }
      ],
      "verbosity": "CONCISE"
    }
  }
}