My API
POST/user

Create a user account

Creates a user account from the supplied user details. Include any applicable fields such as username, email, and password; the request body and all its fields are optional in the schema. 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, accepted as JSON, XML, or URL-encoded form data.

idintegeroptional
The user's integer 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, including its identifier and user details.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional
User Status
defaultReturned when an unexpected error occurs.

Error handling

The request body is optional, and none of its fields is required. If you supply fields, id and userStatus must be integers, and username, firstName, lastName, email, password, and phone must be strings.