POST/user

Create a user

Creates a user account from the supplied user details. The body is optional, and the schema does not mark any of its fields as required. Only the authenticated user can perform this operation.

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

8 body fields

An optional user object.

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

Error handling

The body is optional, and the schema does not mark any user fields as required. If you supply a user object, fields such as username, email, and password are strings; the schema specifies no additional value or format constraints.