Create Contact

Create 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 creates the contact; the response returns its id.

Create a contact

post

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

Body

Create a contact

primaryEmailstring · nullableOptional

Primary email address of the contact (optional if a phone is given).

primaryPhonestring · nullableOptional

Primary phone number in international format, e.g. [phone] (optional if an email is given).

displayNamestring · nullableOptional

Display name shown in the dashboard (optional).

firstNamestring · nullableOptional

Contact's first name (optional).

lastNamestring · nullableOptional

Contact's last name (optional).

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

post/{version}/membership/users

POST /{version}/membership/users HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 244

{
  "primaryEmail": "text",
  "primaryPhone": "text",
  "displayName": "text",
  "firstName": "text",
  "lastName": "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 Create Contact in the SDK reference, with examples in every language.