POST/user

Create a user account

Creates a user account. Supply user details in the optional request body, using fields such as username, email, and password as needed. The response contains the created user object.

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

8 body fields

User account details. All fields are optional.

emailstringoptional

The user's email address.

firstNamestringoptional

The user's first name.

idintegeroptional

The user's identifier as a 64-bit integer.

lastNamestringoptional

The user's last name.

passwordstringoptional

The user's password.

phonestringoptional

The user's phone number.

userStatusintegeroptional

User Status

usernamestringoptional

The user's username.

2 status codes
200Returns the user object, including its identifier and any submitted account details.
emailstringoptional
firstNamestringoptional
idintegeroptional
lastNamestringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

usernamestringoptional
defaultReturned when an unexpected error occurs.

Error handling

The request body is optional; when you provide it, use the defined user fields such as username, email, and password. The schema does not mark any fields as required or specify additional value constraints.