POST/user

Create a user

Creates a user account from the supplied user details. Include fields such as username, email, and password in the optional request body. Only the logged-in user can perform this operation.

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

8 body fields

User account details to create; all fields are optional.

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, and status.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultUnexpected error

Error handling

The request body has no required fields in the schema, so you can provide any of the defined user fields. Only the logged-in user can perform this operation.