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

Update Contact

Update a contact.

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 contact — only the fields you send are changed.

Update a contact

patch
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
contactIdstringRequired

The contact id (ct_…) to update. Get it from get_all_contacts.

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

Body

Update a contact

displayNamestring · nullableOptional

Display name shown in the dashboard.

firstNamestring · nullableOptional

First name.

lastNamestring · nullableOptional

Last name.

fullNamestring · nullableOptional

Full name (overrides first/last when set).

companystring · nullableOptional

Company or organisation name.

notesstring · nullableOptional

Free-text internal notes about the contact.

genderstring · nullableOptional

Gender: Male, Female or Other.

birthDateinteger · int64 · nullableOptional

Birth date as a unix timestamp in MILLISECONDS (UTC).

timeZonestring · nullableOptional

IANA time zone id, e.g. Europe/Vilnius.

languagestring · nullableOptional

Preferred language/locale code, e.g. en or en-US.

addressLine1string · nullableOptional

Address line 1 (street).

addressLine2string · nullableOptional

Address line 2 (apartment, suite, etc.).

countrystring · nullableOptional

Country name or code.

citystring · nullableOptional

City.

statestring · nullableOptional

State, region or province.

postalCodestring · nullableOptional

Postal or ZIP code.

projectIdstringRequired

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

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.

cultureCodestring · nullableOptional

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

timeZoneIdstring · nullableOptional

TimeZone

correlationIdstring · nullableOptional

CorrelationId for each request

Responses
200

OK

application/json
patch/{version}/membership/users/{contactId}
PATCH /{version}/membership/users/{contactId} HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 426

{
  "displayName": "text",
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "company": "text",
  "notes": "text",
  "gender": "text",
  "birthDate": 1,
  "timeZone": "text",
  "language": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "country": "text",
  "city": "text",
  "state": "text",
  "postalCode": "text",
  "projectId": "text",
  "env": "text",
  "resolvedEnv": {
    "value": "text",
    "isProd": true
  },
  "cultureCode": "text",
  "timeZoneId": "text",
  "correlationId": "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 Contact in the SDK reference, with examples in every language.

Last updated