POST/user

Create a user account

Creates a user account for the authenticated user. Supply user profile fields in the optional request body; the schema does not mark any fields as required.

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

8 body fields

Optional user profile data. You can send the body as JSON, XML, or URL-encoded form data.

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

Error handling

The request body and all of its fields are optional in the schema, so no field is required for submission. Include username and other profile fields when you want them set on the created user.