POST
/
api
/
v1
/
sdk
/
users
Create User
curl --request POST \
  --url https://2d89d8691199.ngrok-free.app/api/v1/sdk/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "appUserId": "<string>",
  "userPlatform": "<string>",
  "locale": "<string>",
  "email": "<string>",
  "country": "<string>"
}'
Create a new user in your project. This endpoint allows you to register users with platform and locale information.
​
appUserId
string
Your app’s custom user identifier
​
userPlatform
string
required
Platform (IOS, ANDROID, WEB, OTHER)
​
locale
string
required
User’s locale/language (e.g., “en_US”)
​
email
string
User email address (must be valid email)
​
country
string
User’s country code

​
Response Fields

FieldTypeRequiredDescription
idstringYesUnique user identifier (auto-generated)
projectIdstringYesProject this user belongs to
appUserIdstringNoYour app’s custom user identifier
emailstringNoUser email address
monthlyRevenuenumberNoUser’s monthly revenue (null initially)
countrystringNoUser’s country
userPlatformstringNoPlatform
localestringNoUser’s locale
createdAtstringYesUser creation timestamp (ISO 8601)
updatedAtstringYesLast update timestamp (ISO 8601)

​
Example Request

{
  "appUserId": "my_user_789",
  "userPlatform": "IOS",
  "locale": "en_US",
  "email": "newuser@example.com",
  "country": "US"
}

​
Example Response

{
  "id": "clm7x1a2b000008l7h3k1b2c3",
  "projectId": "clm7x1a2b000008l7h3k1b2c3", 
  "appUserId": "my_user_789",
  "email": "newuser@example.com",
  "monthlyRevenue": null,
  "country": "US",
  "userPlatform": "IOS",
  "locale": "en_US",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

​
Error Responses

Status CodeDescriptionExample Response
400Bad request - Missing required fields{"error": "userPlatform and locale are required"}
401Unauthorized - Invalid API key{"error": "Unauthorized"}
500Internal server error{"error": "Failed to create user"}