Introduction - Game Loom

Adding your users to Game Loom is simple — you only need to call a single endpoint.

Game Loom does not require any sensitive user data. The only required field is userKey, which serves as a unique identifier for the user within Game Loom.

You may also provide an optional name property to improve readability within the Game Loom dashboard. Additionally, you can attach any custom data to the user, which can be helpful for future targeting and data analysis.

{
  "userKey": "string",
  "name": "string",
  "nameAr": "string",
  "userProperties": {
    "gender": 0,
    "birthDate": "2026-03-17T01:51:09.297Z",
    "country": "string",
    "city": "string",
    "segment": "string"
  }
}

Country & City

The country and city fields use standardized lookup IDs to ensure consistent data across all clients.

For country, use the ISO 3166-1 alpha-2 country code (e.g. "SA" for Saudi Arabia, "EG" for Egypt). For city, use the composite slug ID which combines the country code with the city name (e.g. "SA-riyadh", "EG-cairo").

You can retrieve the full list of supported values from these endpoints:

Countries: GET /api/lookups/countries

Cities by country: GET /api/lookups/cities/{countryId}

Example request:

{
  "userKey": "user-123",
  "name": "Mohammed",
  "nameAr": "محمد",
  "userProperties": {
    "gender": 0,
    "birthDate": "1995-06-15T00:00:00.000Z",
    "country": "SA",
    "city": "SA-riyadh",
    "segment": "premium"
  }
}