POST/user

Create a user

Creates a user account for the authenticated user. Include user details such as username, email, and password in the optional request body; no fields are marked as required.

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

8 body fields

Optional details for the user to create.

idintegeroptional
The user's numeric identifier.
usernamestringoptional
The user's username.
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, including its identifier, username, name, email, password, phone number, and status.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultUnexpected error

Error handling

The request body is optional, and no user fields are required. If you provide user details, id and userStatus must be integers, and the other defined fields must be strings.