Save Phone User

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

Membership

post

Authorizations

Bearer

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

multipart/form-dataapplication/json

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.

databaseIntegrationIdstring · nullableOptional

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

ignoreUserRegistersAsRolebooleanOptional

Ignore UserRegistersAsRole from Membership Settings

userIdstring · nullableOptional

Attach this login to an existing user id. Optional.

phonestringRequired

Phone number for the new user, in E.164 format.

Responses

200

OK

application/json

idstring · nullableOptional

statusstring · nullableOptional

post/{version}/membership/auth/register/phone

HTTPcURLJavaScriptPython

POST /{version}/membership/auth/register/phone HTTP/1.1
Host: api.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 656

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "databaseIntegrationId": "text",
  "ignoreUserRegistersAsRole": true,
  "userGeneralInfo": {
    "phone": "text",
    "primaryEmail": "text",
    "displayName": "text",
    "firstName": "text",
    "lastName": "text",
    "fullName": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "country": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "company": "text",
    "gender": "Male",
    "birthDate": 1,
    "timeZone": "text",
    "language": "text",
    "blockAllMarketingMessages": true,
    "blockedTags": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "blockReasons": null,
    "extraMetadata": "text",
    "notes": "text"
  },
  "userId": "text",
  "phone": "text"
}

multipart/form-dataapplication/json

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "id": "text",
  "status": "text"
}

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 Save Phone User in the SDK reference, with examples in every language.