Update preferences for users

Sets preference selections for a batch of users. Up to 1000 accounts per request. Writes are run concurrently (10 at a time) server-side.

Body fields

  • accounts[].userId - account numeric ID.
  • accounts[].anonymous - true if the user is an anonymous user.
  • accounts[].preferences[].key - preference key from the client catalogue.
  • accounts[].preferences[].selectedOptionIds - the option IDs the user has chosen. Pass [] to clear.

Response

Returns 200 OK with an array of accounts that failed, each annotated with an error field. An empty array means everything succeeded. The endpoint does not fail the whole batch on a single row's error, so always inspect the response body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
accounts
array of objects
required
accounts*
Headers
string
required
string
required
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json