Skip to content
Public API reference
/
/User

Register a user

Request

This endpoint enables clients to initiate the creation of a new user account. If a contact with an identical email address already exists, that contact will be elevated to the status of a registered user. Essential attributes like identifiers.email_address and validators.password are mandatory for this endpoint. If any of these attributes are absent, registration attempts will trigger an error. Upon a successful request, session cookies like blaize_session and blaize_tracking_id are generated and included in the response header.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Bodyapplication/json
identifiersobject(identifiers)required
validatorsobject(validators)required
attributesobject(attributes)
{
  "identifiers": {
    "email_address": "joe.blow@company.com"
  },
  "validators": {
    "password": "mysecurepassword123",
    "use_sso": true
  },
  "attributes": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

OK. The user was registered successfully.

Headers
Bodyapplication/json
cookiestring
messagestring
tracking_idstring
Response
{
  "cookie": "string",
  "message": "string",
  "tracking_id": "string"
}