Create User

Create a new user

POST /v3/users

Request

The details below help you form your HTTP requests to this endpoint.

Headers

You may need to provide specific headers.

Name	Type	Required	Description
x-consumer-custom-id	string		Consumer data with the format "channel:vendorId"

Body

You must provide a JSON payload.

Name	Type	Required	Description
firstName	string		User's first name
lastName	string		User's last name
email	string		Users email address to authenticate with
password	string		User password to authenticate with
resetPassword	boolean		Determines if password reset e-mail will be send
locale	string		Language part of the user locale, not the full locale.

Response

The details below help you understand the responses you could get from this endpoint.

Samples

Below are samples of responses, with tabs corresponding to returned status code.

200

{
    "data": {
        "userId": "5a319511a86980001d602095",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YTk..."
    }
}

400

{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email [email protected]",
        "data": {}
    }
}

409

{
    "error": {
        "statusCode": 409,
        "code": "UserAlreadyExists",
        "message": "The user already exists",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

Name	Type	Required	Description
data	object		N/A
data.userId	string		User id
data.token	string		User authorization token