Bulk Register Users

Here’s the updated version based on the new request payload:

Bulk User Registration

Registers multiple users in a single request. Optimized for high-volume user imports.

Request Body Schema

Each request accepts an array of users with the following structure:

User Object

Field	Type	Required	Description
`userKey`	string	✅ Yes	Unique identifier for the user
`name`	string	❌ No	User’s display name in English
`nameAr`	string	❌ No	User’s display name in Arabic
`isActive`	boolean	✅ Yes	Indicates whether the user is active
`createdDate`	string	✅ Yes	User creation date in ISO 8601 format
`userProperties`	object	✅ Yes	Additional user information

`userProperties` Object

Field	Type	Required	Description
`gender`	integer	❌ No	`0` = Female, `1` = Male
`birthDate`	string	❌ No	User birth date in ISO 8601 format
`country`	string	❌ No	User’s country
`city`	string	❌ No	User’s city
`segments`	string[]	❌ No	List of business-defined user segments (e.g. `Premium`, `Standard`)

Example Request

[
  {
    "userKey": "string",
    "name": "string",
    "nameAr": "string",
    "isActive": true,
    "createdDate": "string",
    "userProperties": {
      "gender": 0,
      "birthDate": "2026-04-16T11:49:48.923Z",
      "country": "string",
      "city": "string",
      "segments": [
        "string"
      ]
    }
  }
]

Response

200 OK — Users registered successfully

No response body (optimized for performance)

Performance & Limits

Suitable for importing 10,000+ users

Recommended maximum: 10,000 users per request

Best Practices

Ensure all userKey values are unique within the batch

All fields inside userProperties are optional

Use valid ISO 8601 date formats for createdDate and birthDate

Use segments to assign a user to one or more business-defined segments

If you want, I can also make it more polished for API docs style with cleaner wording and consistency.

curl --location 'https://api-stg.98s.studio/api/v1/registrations/users/bulk' \ --header 'x-api-key: {{api-key}}' \ --header 'Content-Type: application/json' \ --data '[ { "userKey": "{{$string.uuid}}", "name": "{{$person.fullName}}", "nameAr": "{{$person.fullName}}", "isActive": true, "createdDate": "{{$date.isoTimestamp}}", "userProperties": { "gender": 1, "birthDate": "{{$date.isoTimestamp}}", "country": "{{$location.countryCode}}", "city": "{{$location.city}}", "segments": [ "Premium" ] } }, { "userKey": "{{$string.uuid}}", "name": "{{$person.fullName}}", "nameAr": "{{$person.fullName}}", "isActive": true, "createdDate": "{{$date.isoTimestamp}}", "userProperties": { "gender": 0, "birthDate": "{{$date.isoTimestamp}}", "country": "{{$location.countryCode}}", "city": "{{$location.city}}", "segments": [ "VIP" ] } } ]'

Bulk Register Users

Bulk User Registration#

Request Body Schema#

User Object#

userProperties Object#

Example Request#

Response#

Performance & Limits#

Best Practices#

Request

Responses