Add user
POST /users
Overview
Stores a new user’s information in the database.
This operation is commonly performed immediately after user creation or authentication, allowing the system to accurately track and manage users.
Typical use cases
Saving a newly registered user
Ensuring user consistency across services
Header
Content-Type
application/json
Authorization (API Key)
Bearer <API Key>
Body
email
string
Email of the user
userId (optinal)
string
User identifier (user_id). Optional on create — if not provided, a system-generated ID will be used More description
name (optinal)
string
Name of the user
metadata (optinal)
object
A set of custom key-value pairs to be stored in the user’s profile.
Response
If the required email field is missing from the request body, an error will occur.
A conflict error occurs when a user with the same email or user_id already exists in the app.
Last updated