Create User

This endpoint is used to create a new user. If the new user was created successfully, then the Guid Id of the new user will be returned.

Controlled Errors

Error CodeError Message
error_phonenumber_invalid_formatInvalid phone number format.
error_locale_not_foundLocale provided was not found.
error_phone_number_used_on_same_accountAnother active user is already using the provided phone number.
error_user_email_already_used_on_same_accountAnother active user is already using the provided email.
error_user_not_createdUser creation failed.

Any status codes returned that are not provided here are generic status codes that can be found here.

Body Params
string
required

The email for the new user. Must be in email format ([email protected]) Max length is 150 characters.

string
required

The first name of the user.

string
required

The last name of the user.

string

The phone number of the user. Must be in a valid phone number format. Max length is 25 characters.

string
required

The language locale of the user. For available languages, see languages.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain