Users

Update User Preferences

updates preferences for the currently authenticated user.

put/api/user/v1/preferences

Request body

mainMenuOpenedboolean

If the main menu is opened or closed.

activeUidstring

the active uid of the producer

dismissedMigratedIdsstring[]

consent request ids for which we dont want to show migration notices anymore

hasSeenConsentRequestTourIntroboolean

Indicates whether the user has already seen the consent request feature tour introduction.

Example request

{
  "mainMenuOpened": true,
  "activeUid": "CHE123456789",
  "dismissedMigratedIds": [
    "a5b1d2e3-4f6a-2b7c-6d0e-9f1a3b5c7d9e"
  ],
  "hasSeenConsentRequestTourIntro": true
}

Response

No Content

Changes

Changed in 8 of the 56 revisions of this API.155

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

    • removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 404

      response-property-enum-value-removed

    • removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 500

      response-property-enum-value-removed

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

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_EXPIRED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_EXPIRED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_INVALID enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_INVALID enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_LOCKED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_LOCKED enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 500

      response-property-enum-value-added

    • added the new optional request property hasSeenConsentRequestTourIntro

      new-optional-request-property

    • added the new CONSENT_NOT_GRANTED enum value to the type response property for the response status 404

      response-property-enum-value-added

    • added the new CONSENT_NOT_GRANTED enum value to the type response property for the response status 500

      response-property-enum-value-added

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

  • 297b7932dd8311See the full diff
    • removed the request property dismissedMiratedIds

      request-property-removed

    • added the new optional request property dismissedMigratedIds

      new-optional-request-property

    • endpoint added

      endpoint-added