Sync Games

Automatically synchronizes all games between the client’s system and Gamity. Using this endpoint is optional but highly recommended to avoid the need for manual synchronization within Gamity’s back office.

The entire relevant game portfolio should be sent in this call, which will merge with the existing games in Gamity. New games will be added, games missing in the client’s system but existing in Gamity will be disabled, and existing games will be updated.

Interactive swagger page (under the “External” group): Swagger UI

Example request

POST https://qa-ec1.transaction-api.gamity.io/external/{INTEGRATION_ID}/sync-games
Content-Type: application/json
X-API-Key: {ask from Codemodity}
 
[
  {
    "gameId": "PNG_GUNSLINGER_RELOADED",
    "displayName": "Gunslinger Reloaded",
    "gameProviderDisplayName": "Play'n GO",
    "isEnabled": true,
    "isFreeroundSupported": true,
    "iconUrl": "https://example.com/icon.png",
    "enabledBrandRefs": [
      "brand1", "brand2"
    ]
  },
  {
    "gameId": "EVO_ANDAR_BAHAR_1",
    "displayName": "Andar Bahar",
    "gameProviderDisplayName": "Evolution",
    "isEnabled": true,
    "isFreeroundSupported": true,
    "iconUrl": "https://example.com/icon.png",
    "enabledBrandRefs": [
      "brand2"
    ]
  }
]

Request parameters

Parameter	Type	Required	Default	Description
gameId	string	Yes		Uniquely identifies a game across all game providers and aggregators. This can be an internal ID or a concatenation of a game provider ID and a game ID. No specific format is required, but it must be a maximum of 100 characters in length.
displayName	string	Yes		Display name of the game shown in both the backoffice and player-facing UIs. This name is not translated and will appear the same across all languages.
gameProviderDisplayName	string	Yes		Human-readable name of the game provider. This is used to visually group games in the backoffice.
isEnabled	boolean	Yes		Indicates whether the game is globally enabled or disabled (irrespective of which brands it belongs to).
isFreeroundSupported	boolean	Yes		Indicates if the game supports free rounds. This setting controls the prize type in tournaments; if the game supports free rounds, the prize type can be set to free rounds.
launchId	string	No	null	Required only if it differs from GameId. Some game providers define a separate ID for launching a game on desktop, mobile, or for specific game transactions.
launchIdMobile	string	No	null	Required only if it differs from GameId. Some game providers define a separate ID for launching a game on desktop, mobile, or for specific game transactions.
gameIdMobile	string	No	null	Required only if it differs from GameId. Some game providers define a separate ID for launching a game on desktop, mobile, or for specific game transactions.
rtp	number (double)	No	null	The return-to-player (RTP) percentage for the game. Used for calculating P&L in the performance reports.
iconUrl	string	No	null	CDN image URL for the game icon. Gamity will use this URL to display the game icon in both the backoffice and player-facing UIs. If not provided, the icon must be uploaded to Gamity’s CDN in the backoffice.
enabledBrandRefs	string[]	No	null	An array of brands for which the game is enabled. If not set, the game is disabled for all brands. To enable the game for all brands, either list all brands or use a single array element with a wildcard `[""]`. The available brand references are predefined and provided by Gamity during account setup.

Response codes

HTTP Status Code	Description
200	OK - The request was successfully processed. The game information has been synchronized as expected.
400	Bad Request - The request was invalid. This can occur due to missing required parameters, incorrect parameter types, or malformed request data.
401	Unauthorized - The API key is missing or invalid.

Active games Sync operators and brands