POST/user

Create a user account

Creates a new user account in the system. Supply user details such as username, email, password, and contact information. The request body is optional — if omitted, a user with default values is created. Returns the created user object on success.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

8 body fields

User object to create. All fields are optional.

idintegeroptional

The unique identifier for the user.

usernamestringoptional

The login name for the user account.

firstNamestringoptional

The user's first name.

lastNamestringoptional

The user's last name.

emailstringoptional

The user's email address.

passwordstringoptional

The user's password.

phonestringoptional

The user's phone number.

userStatusintegeroptional

User Status

2 status codes
200Returns the created user object with all supplied fields.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

defaultUnexpected error

Error handling

All fields in the request body are optional, but username should be unique within the system. id and userStatus are integers; ensure numeric values are provided if these fields are included.