t
POST/user

Create a user account

Creates a user account from the supplied user object. Provide account details in fields such as username, email, and password; the schema does not require any individual field.

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

8 body fields

User account details. The body and all individual fields are optional.

emailstringoptional

The user's email address.

firstNamestringoptional

The user's first name.

idintegeroptional

The user's integer identifier, in int64 format.

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 account details.
emailstringoptional
firstNamestringoptional
idintegeroptional
lastNamestringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

usernamestringoptional
defaultUnexpected error

Error handling

The request body is optional, and no individual user field is schema-required. If you provide a body, use the defined fields such as username, email, and password.