Skip to main content
Use this endpoint to create a new user within your project. Users are scoped to both the project and workspace mode (TEST or LIVE).
POST

Authorization

All you need is to include your secret key as a value of authorization in the header and hit the endpoint above.
string
required
Use the secret key that matches the mode you are in TEST or LIVE

Request Body

Provide the user’s email address and optionally include their name and country code.
string
required
The email address of the user. Must be a valid email format.
string
The name of the user (optional)
string
A 2-letter ISO country code (e.g., “US”, “GB”, “FR”). Must be uppercase or will be converted to uppercase.
Users are unique per project and mode combination. The same email can exist in both TEST and LIVE modes.

Response

If the user is created successfully, you will receive an object containing the user’s details.

Error Responses

Returned when the request body is missing or empty.
Returned when the email field is not provided.
Returned when the email format is invalid.
Returned when the country code is not a valid 2-letter code.
Returned when the request body contains malformed JSON.
Returned when a user with the same email already exists in this project and mode.
Returned when an unexpected error occurs.