POST/user

Create a user

Creates a user account from the supplied user properties. Include any properties you want to set; 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 properties to create, accepted as JSON, form data, or XML.

emailstringoptional

The user's email address.

firstNamestringoptional

The user's first name.

idintegeroptional

The user's integer identifier.

lastNamestringoptional

The user's last name.

passwordstringoptional

The user's password.

phonestringoptional

The user's phone number.

userStatusintegeroptional

User Status

usernamestringoptional

The user's username.

2 status codes
200Returns the created user object, including its email, name, identifier, password, phone, status, and username.
emailstringoptional
firstNamestringoptional
idintegeroptional
lastNamestringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

usernamestringoptional
defaultReturned when an unexpected error occurs.

Error handling

The request body is optional, and no user fields are required. Include only the properties you want to set, such as username or email.