POST/user

Create a user account

Creates a user account from the supplied user attributes. Send the optional user object as JSON, XML, or form-urlencoded data; the schema defines no required fields.

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

8 body fields

Optional user object; all properties are optional and may be sent as JSON, XML, or form-urlencoded data.

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

Error handling

The request body is optional, and the schema defines no required user fields. When you provide a body, id and userStatus must be integers; the other user attributes must be strings.