POST/user

Create a user

Creates a user account. Use this operation when the authenticated user needs to add a user. The request body is optional and can be sent as JSON, XML, or URL-encoded form data.

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

8 body fields

User account details, supplied as JSON, XML, or URL-encoded form data.

idintegeroptional
The user's 64-bit integer identifier.
usernamestringoptional
The user's login name.
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 and account details.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultUnexpected error

Error handling

The authenticated user must be logged in to create a user. The request body is optional and defines no required fields; if supplied, id and userStatus must be integers, and the other defined fields must be strings.