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
https://api.taag.cc/v1/users/create

​
Authorization

All you need is to include your secret key as a value of authorization in the header and hit the endpoint above. 
Authorization: taag_sk_mode_xxxxxxxxx
​
Authorization
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. 
{
  "email": "[email protected]",
  "name": "John Doe",
  "countryCode": "US"
}
​
email
string
required
The email address of the user. Must be a valid email format.
​
name
string
The name of the user (optional)
​
countryCode
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. 
{
  "success": true,
  "data": {
    "email": "[email protected]",
    "name": "John Doe",
    "countryCode": "US",
    "mode": "TEST",
    "createdAt": "2025-12-12T10:30:00.000Z"
  }
}

​
Error Responses

Returned when the request body is missing or empty.
{
  "success": false,
  "error": "Missing request body",
  "description": "Request body is required with email" 
}
Returned when the email field is not provided.
{
  "success": false, 
  "error": "Missing required fields", 
  "description": "email is required"
}
Returned when the email format is invalid.
{
  "success": false, 
  "error": "Invalid email", 
  "description": "Please provide a valid email address"
}
Returned when the country code is not a valid 2-letter code.
{
  "success": false, 
  "error": "Invalid country code", 
  "description": "countryCode must be a 2-letter country code (e.g., \"US\", \"GB\", \"FR\")"
}
Returned when the request body contains malformed JSON.
{
  "success": false, 
  "error": "Invalid JSON", 
  "description": "The request body contains invalid JSON. Please check for syntax errors like trailing commas or missing quotes."
}
Returned when a user with the same email already exists in this project and mode.
{
  "success": false, 
  "error": "User already exists", 
  "description": "A user with email [email protected] already exists in this project for TEST mode"
}
Returned when an unexpected error occurs.
{
  "success": false, 
  "error": "Internal Server Error", 
  "description": "An unexpected error occurred while creating the project user. Please try again or contact support if the issue persists."
}