POST/user

Create a user account

Creates a user account from a user object. Include profile details such as username, email, and password in the optional request body. Only the authenticated user can perform this operation.

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

8 body fields

User details for the account to create.

idintegeroptional
The user's numeric identifier.
usernamestringoptional
The user's account 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 with its account and profile fields.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultUnexpected error

Error handling

The request body is optional; include username and any other profile fields you want to create. Only the authenticated user can perform this operation.