Bulk Register Users
POST
api/v1/registrations/users/bulk
Bulk User Registration
Request Body Schema
User Object
| Field | Type | Required | Description |
|---|---|---|---|
userKey | string | âś… Yes | Unique identifier for the user |
name | string | ❌ No | User’s display name |
userProperties | object | âś… Yes | Additional user information |
userProperties Object
| Field | Type | Description |
|---|---|---|
gender | integer | 0 = Female, 1 = Male |
birthDate | string | ISO 8601 date format (YYYY-MM-DD) |
country | string | User’s country |
city | string | User’s city |
segment | string | Business-defined user segment (e.g. Premium, Standard) |
Response
200 OK — Users registered successfullyPerformance & Limits
Best Practices
userKey values are unique within the batchuserProperties are optionalbirthDateRequest
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'api/v1/registrations/users/bulk' \
--header 'x-api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"userKey": "{{$string.uuid}}",
"name": "{{$person.fullName}}",
"userProperties": {
"gender": 1,
"birthDate": "{{$date.isoTimestamp}}",
"country": "{{$location.countryCode}}",
"city": "{{$location.city}}",
"segment": "Premium"
}
},
{
"userKey": "{{$string.uuid}}",
"name": "{{$person.fullName}}",
"userProperties": {
"gender": 0,
"birthDate": "{{$date.isoTimestamp}}",
"country": "{{$location.countryCode}}",
"city": "{{$location.city}}",
"segment": "VIP"
}
}
]'Modified at 2025-12-23 15:35:55