For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update User Preferences

Membership.

A contact (user) is a person in your project's membership directory, with one or more linked logins (identities). Membership manages their profile, identities, roles, and lifecycle.

This endpoint updates the user preferences — only the fields you send are changed.

Membership

put
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

idstringRequired

Id of the user to update, from get_users.

Body

Membership

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

blockAllMarketingMessagesbooleanOptional

When true, blocks all marketing messages to this user.

blockedTagsobject · Dictionary<String,HashSet<String>> · nullableOptional

Per communication channel, the set of tags blocked for this user. Full replacement.

databaseIntegrationIdstring · nullableOptional

Database integration id. Optional — defaults to the project's default integration.

Responses
200

OK

application/json
put/{version}/membership/auth/{id}/preferences
PUT /{version}/membership/auth/{id}/preferences HTTP/1.1
Host: api.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 208

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "blockAllMarketingMessages": true,
  "blockedTags": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "databaseIntegrationId": "text"
}
200

OK

{
  "responseStatus": {
    "isSuccess": true
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Membership → Users.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Update User Preferences in the SDK reference, with examples in every language.

Last updated