Skip to main content
PATCH
/
game-configs
/
{id}
Update a game config
curl --request PATCH \
  --url https://{subdomain}.nudj.cx/api/v2/admin/game-configs/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "config": {
    "clientBranding": {
      "gameTitle": "<string>",
      "gameDescription": "<string>",
      "clientName": "<string>",
      "clientWebsite": "<string>",
      "background": {
        "image": "<string>",
        "color": "<string>"
      },
      "logo": {
        "url": "<string>",
        "alt": "<string>"
      },
      "favicon": "<string>",
      "font": "<string>",
      "colors": {
        "primary": "<string>",
        "on-primary": "<string>",
        "secondary": "<string>",
        "on-secondary": "<string>",
        "accent": "<string>",
        "on-accent": "<string>"
      },
      "style": {
        "cornerRadius": 123
      },
      "icons": {
        "play": "<string>",
        "pause": "<string>",
        "restart": "<string>",
        "home": "<string>",
        "volume": "<string>",
        "volume-off": "<string>",
        "level-completed": "<string>",
        "level-failed": "<string>",
        "game-completed": "<string>",
        "game-over": "<string>",
        "star": "<string>"
      }
    },
    "gameConfig": {
      "game": "<string>",
      "odds": 0.5,
      "scratchCardImage": "<string>",
      "backgroundImage": "<string>",
      "productImages": [
        {
          "id": "<string>",
          "url": "<string>",
          "alt": "<string>",
          "winning": true,
          "distributionEventId": "<string>"
        }
      ],
      "particlesColor": "<string>",
      "cardColor": "<string>",
      "cardGlowingColor": "<string>",
      "cardTextColor": "<string>",
      "sounds": {
        "win": "<string>",
        "lose": "<string>"
      }
    },
    "textContent": {
      "loading": {
        "title": "<string>",
        "subtitle": "<string>",
        "progressText": "<string>",
        "logoAlt": "<string>"
      },
      "home": {
        "startButton": "<string>",
        "loadingText": "<string>",
        "preparingText": "<string>",
        "features": [
          {
            "title": "<string>",
            "description": "<string>"
          }
        ]
      },
      "tutorial": {
        "title": "<string>",
        "subtitle": "<string>",
        "startButton": "<string>",
        "logoAlt": "<string>",
        "instructions": [
          {
            "icon": "<string>",
            "title": "<string>",
            "description": "<string>"
          }
        ]
      },
      "gameUI": {
        "soundToggle": {
          "enable": "<string>",
          "disable": "<string>"
        },
        "pauseToggle": {
          "pause": "<string>",
          "resume": "<string>"
        }
      },
      "modals": {
        "win": {
          "title": "<string>",
          "subtitle": "<string>",
          "homeButton": "<string>",
          "closeButton": "<string>"
        },
        "lose": {
          "title": "<string>",
          "subtitle": "<string>",
          "homeButton": "<string>",
          "closeButton": "<string>"
        }
      },
      "errors": {
        "configurationError": "<string>",
        "configurationErrorMessage": "<string>",
        "retryButton": "<string>",
        "imageLoadError": "<string>"
      },
      "accessibility": {
        "playButton": "<string>",
        "pauseButton": "<string>",
        "homeButton": "<string>",
        "progressIndicator": "<string>"
      },
      "status": {
        "gameStarted": "<string>",
        "win": "<string>",
        "lose": "<string>"
      }
    }
  },
  "maxCompletionsPerPeriod": 1,
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  }
}
'
import requests

url = "https://{subdomain}.nudj.cx/api/v2/admin/game-configs/{id}"

payload = {
    "config": {
        "clientBranding": {
            "gameTitle": "<string>",
            "gameDescription": "<string>",
            "clientName": "<string>",
            "clientWebsite": "<string>",
            "background": {
                "image": "<string>",
                "color": "<string>"
            },
            "logo": {
                "url": "<string>",
                "alt": "<string>"
            },
            "favicon": "<string>",
            "font": "<string>",
            "colors": {
                "primary": "<string>",
                "on-primary": "<string>",
                "secondary": "<string>",
                "on-secondary": "<string>",
                "accent": "<string>",
                "on-accent": "<string>"
            },
            "style": { "cornerRadius": 123 },
            "icons": {
                "play": "<string>",
                "pause": "<string>",
                "restart": "<string>",
                "home": "<string>",
                "volume": "<string>",
                "volume-off": "<string>",
                "level-completed": "<string>",
                "level-failed": "<string>",
                "game-completed": "<string>",
                "game-over": "<string>",
                "star": "<string>"
            }
        },
        "gameConfig": {
            "game": "<string>",
            "odds": 0.5,
            "scratchCardImage": "<string>",
            "backgroundImage": "<string>",
            "productImages": [
                {
                    "id": "<string>",
                    "url": "<string>",
                    "alt": "<string>",
                    "winning": True,
                    "distributionEventId": "<string>"
                }
            ],
            "particlesColor": "<string>",
            "cardColor": "<string>",
            "cardGlowingColor": "<string>",
            "cardTextColor": "<string>",
            "sounds": {
                "win": "<string>",
                "lose": "<string>"
            }
        },
        "textContent": {
            "loading": {
                "title": "<string>",
                "subtitle": "<string>",
                "progressText": "<string>",
                "logoAlt": "<string>"
            },
            "home": {
                "startButton": "<string>",
                "loadingText": "<string>",
                "preparingText": "<string>",
                "features": [
                    {
                        "title": "<string>",
                        "description": "<string>"
                    }
                ]
            },
            "tutorial": {
                "title": "<string>",
                "subtitle": "<string>",
                "startButton": "<string>",
                "logoAlt": "<string>",
                "instructions": [
                    {
                        "icon": "<string>",
                        "title": "<string>",
                        "description": "<string>"
                    }
                ]
            },
            "gameUI": {
                "soundToggle": {
                    "enable": "<string>",
                    "disable": "<string>"
                },
                "pauseToggle": {
                    "pause": "<string>",
                    "resume": "<string>"
                }
            },
            "modals": {
                "win": {
                    "title": "<string>",
                    "subtitle": "<string>",
                    "homeButton": "<string>",
                    "closeButton": "<string>"
                },
                "lose": {
                    "title": "<string>",
                    "subtitle": "<string>",
                    "homeButton": "<string>",
                    "closeButton": "<string>"
                }
            },
            "errors": {
                "configurationError": "<string>",
                "configurationErrorMessage": "<string>",
                "retryButton": "<string>",
                "imageLoadError": "<string>"
            },
            "accessibility": {
                "playButton": "<string>",
                "pauseButton": "<string>",
                "homeButton": "<string>",
                "progressIndicator": "<string>"
            },
            "status": {
                "gameStarted": "<string>",
                "win": "<string>",
                "lose": "<string>"
            }
        }
    },
    "maxCompletionsPerPeriod": 1,
    "details": {
        "title": "<string>",
        "description": "<string>",
        "light": {
            "primaryImageUrl": "<string>",
            "secondaryImageUrl": "<string>"
        },
        "dark": {
            "primaryImageUrl": "<string>",
            "secondaryImageUrl": "<string>"
        }
    }
}
headers = {
    "x-api-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    config: {
      clientBranding: {
        gameTitle: '<string>',
        gameDescription: '<string>',
        clientName: '<string>',
        clientWebsite: '<string>',
        background: {image: '<string>', color: '<string>'},
        logo: {url: '<string>', alt: '<string>'},
        favicon: '<string>',
        font: '<string>',
        colors: {
          primary: '<string>',
          'on-primary': '<string>',
          secondary: '<string>',
          'on-secondary': '<string>',
          accent: '<string>',
          'on-accent': '<string>'
        },
        style: {cornerRadius: 123},
        icons: {
          play: '<string>',
          pause: '<string>',
          restart: '<string>',
          home: '<string>',
          volume: '<string>',
          'volume-off': '<string>',
          'level-completed': '<string>',
          'level-failed': '<string>',
          'game-completed': '<string>',
          'game-over': '<string>',
          star: '<string>'
        }
      },
      gameConfig: {
        game: '<string>',
        odds: 0.5,
        scratchCardImage: '<string>',
        backgroundImage: '<string>',
        productImages: [
          {
            id: '<string>',
            url: '<string>',
            alt: '<string>',
            winning: true,
            distributionEventId: '<string>'
          }
        ],
        particlesColor: '<string>',
        cardColor: '<string>',
        cardGlowingColor: '<string>',
        cardTextColor: '<string>',
        sounds: {win: '<string>', lose: '<string>'}
      },
      textContent: {
        loading: {
          title: '<string>',
          subtitle: '<string>',
          progressText: '<string>',
          logoAlt: '<string>'
        },
        home: {
          startButton: '<string>',
          loadingText: '<string>',
          preparingText: '<string>',
          features: [{title: '<string>', description: '<string>'}]
        },
        tutorial: {
          title: '<string>',
          subtitle: '<string>',
          startButton: '<string>',
          logoAlt: '<string>',
          instructions: [{icon: '<string>', title: '<string>', description: '<string>'}]
        },
        gameUI: {
          soundToggle: {enable: '<string>', disable: '<string>'},
          pauseToggle: {pause: '<string>', resume: '<string>'}
        },
        modals: {
          win: {
            title: '<string>',
            subtitle: '<string>',
            homeButton: '<string>',
            closeButton: '<string>'
          },
          lose: {
            title: '<string>',
            subtitle: '<string>',
            homeButton: '<string>',
            closeButton: '<string>'
          }
        },
        errors: {
          configurationError: '<string>',
          configurationErrorMessage: '<string>',
          retryButton: '<string>',
          imageLoadError: '<string>'
        },
        accessibility: {
          playButton: '<string>',
          pauseButton: '<string>',
          homeButton: '<string>',
          progressIndicator: '<string>'
        },
        status: {gameStarted: '<string>', win: '<string>', lose: '<string>'}
      }
    },
    maxCompletionsPerPeriod: 1,
    details: {
      title: '<string>',
      description: '<string>',
      light: {primaryImageUrl: '<string>', secondaryImageUrl: '<string>'},
      dark: {primaryImageUrl: '<string>', secondaryImageUrl: '<string>'}
    }
  })
};

fetch('https://{subdomain}.nudj.cx/api/v2/admin/game-configs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.nudj.cx/api/v2/admin/game-configs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'config' => [
        'clientBranding' => [
                'gameTitle' => '<string>',
                'gameDescription' => '<string>',
                'clientName' => '<string>',
                'clientWebsite' => '<string>',
                'background' => [
                                'image' => '<string>',
                                'color' => '<string>'
                ],
                'logo' => [
                                'url' => '<string>',
                                'alt' => '<string>'
                ],
                'favicon' => '<string>',
                'font' => '<string>',
                'colors' => [
                                'primary' => '<string>',
                                'on-primary' => '<string>',
                                'secondary' => '<string>',
                                'on-secondary' => '<string>',
                                'accent' => '<string>',
                                'on-accent' => '<string>'
                ],
                'style' => [
                                'cornerRadius' => 123
                ],
                'icons' => [
                                'play' => '<string>',
                                'pause' => '<string>',
                                'restart' => '<string>',
                                'home' => '<string>',
                                'volume' => '<string>',
                                'volume-off' => '<string>',
                                'level-completed' => '<string>',
                                'level-failed' => '<string>',
                                'game-completed' => '<string>',
                                'game-over' => '<string>',
                                'star' => '<string>'
                ]
        ],
        'gameConfig' => [
                'game' => '<string>',
                'odds' => 0.5,
                'scratchCardImage' => '<string>',
                'backgroundImage' => '<string>',
                'productImages' => [
                                [
                                                                'id' => '<string>',
                                                                'url' => '<string>',
                                                                'alt' => '<string>',
                                                                'winning' => true,
                                                                'distributionEventId' => '<string>'
                                ]
                ],
                'particlesColor' => '<string>',
                'cardColor' => '<string>',
                'cardGlowingColor' => '<string>',
                'cardTextColor' => '<string>',
                'sounds' => [
                                'win' => '<string>',
                                'lose' => '<string>'
                ]
        ],
        'textContent' => [
                'loading' => [
                                'title' => '<string>',
                                'subtitle' => '<string>',
                                'progressText' => '<string>',
                                'logoAlt' => '<string>'
                ],
                'home' => [
                                'startButton' => '<string>',
                                'loadingText' => '<string>',
                                'preparingText' => '<string>',
                                'features' => [
                                                                [
                                                                                                                                'title' => '<string>',
                                                                                                                                'description' => '<string>'
                                                                ]
                                ]
                ],
                'tutorial' => [
                                'title' => '<string>',
                                'subtitle' => '<string>',
                                'startButton' => '<string>',
                                'logoAlt' => '<string>',
                                'instructions' => [
                                                                [
                                                                                                                                'icon' => '<string>',
                                                                                                                                'title' => '<string>',
                                                                                                                                'description' => '<string>'
                                                                ]
                                ]
                ],
                'gameUI' => [
                                'soundToggle' => [
                                                                'enable' => '<string>',
                                                                'disable' => '<string>'
                                ],
                                'pauseToggle' => [
                                                                'pause' => '<string>',
                                                                'resume' => '<string>'
                                ]
                ],
                'modals' => [
                                'win' => [
                                                                'title' => '<string>',
                                                                'subtitle' => '<string>',
                                                                'homeButton' => '<string>',
                                                                'closeButton' => '<string>'
                                ],
                                'lose' => [
                                                                'title' => '<string>',
                                                                'subtitle' => '<string>',
                                                                'homeButton' => '<string>',
                                                                'closeButton' => '<string>'
                                ]
                ],
                'errors' => [
                                'configurationError' => '<string>',
                                'configurationErrorMessage' => '<string>',
                                'retryButton' => '<string>',
                                'imageLoadError' => '<string>'
                ],
                'accessibility' => [
                                'playButton' => '<string>',
                                'pauseButton' => '<string>',
                                'homeButton' => '<string>',
                                'progressIndicator' => '<string>'
                ],
                'status' => [
                                'gameStarted' => '<string>',
                                'win' => '<string>',
                                'lose' => '<string>'
                ]
        ]
    ],
    'maxCompletionsPerPeriod' => 1,
    'details' => [
        'title' => '<string>',
        'description' => '<string>',
        'light' => [
                'primaryImageUrl' => '<string>',
                'secondaryImageUrl' => '<string>'
        ],
        'dark' => [
                'primaryImageUrl' => '<string>',
                'secondaryImageUrl' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{subdomain}.nudj.cx/api/v2/admin/game-configs/{id}"

	payload := strings.NewReader("{\n  \"config\": {\n    \"clientBranding\": {\n      \"gameTitle\": \"<string>\",\n      \"gameDescription\": \"<string>\",\n      \"clientName\": \"<string>\",\n      \"clientWebsite\": \"<string>\",\n      \"background\": {\n        \"image\": \"<string>\",\n        \"color\": \"<string>\"\n      },\n      \"logo\": {\n        \"url\": \"<string>\",\n        \"alt\": \"<string>\"\n      },\n      \"favicon\": \"<string>\",\n      \"font\": \"<string>\",\n      \"colors\": {\n        \"primary\": \"<string>\",\n        \"on-primary\": \"<string>\",\n        \"secondary\": \"<string>\",\n        \"on-secondary\": \"<string>\",\n        \"accent\": \"<string>\",\n        \"on-accent\": \"<string>\"\n      },\n      \"style\": {\n        \"cornerRadius\": 123\n      },\n      \"icons\": {\n        \"play\": \"<string>\",\n        \"pause\": \"<string>\",\n        \"restart\": \"<string>\",\n        \"home\": \"<string>\",\n        \"volume\": \"<string>\",\n        \"volume-off\": \"<string>\",\n        \"level-completed\": \"<string>\",\n        \"level-failed\": \"<string>\",\n        \"game-completed\": \"<string>\",\n        \"game-over\": \"<string>\",\n        \"star\": \"<string>\"\n      }\n    },\n    \"gameConfig\": {\n      \"game\": \"<string>\",\n      \"odds\": 0.5,\n      \"scratchCardImage\": \"<string>\",\n      \"backgroundImage\": \"<string>\",\n      \"productImages\": [\n        {\n          \"id\": \"<string>\",\n          \"url\": \"<string>\",\n          \"alt\": \"<string>\",\n          \"winning\": true,\n          \"distributionEventId\": \"<string>\"\n        }\n      ],\n      \"particlesColor\": \"<string>\",\n      \"cardColor\": \"<string>\",\n      \"cardGlowingColor\": \"<string>\",\n      \"cardTextColor\": \"<string>\",\n      \"sounds\": {\n        \"win\": \"<string>\",\n        \"lose\": \"<string>\"\n      }\n    },\n    \"textContent\": {\n      \"loading\": {\n        \"title\": \"<string>\",\n        \"subtitle\": \"<string>\",\n        \"progressText\": \"<string>\",\n        \"logoAlt\": \"<string>\"\n      },\n      \"home\": {\n        \"startButton\": \"<string>\",\n        \"loadingText\": \"<string>\",\n        \"preparingText\": \"<string>\",\n        \"features\": [\n          {\n            \"title\": \"<string>\",\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"tutorial\": {\n        \"title\": \"<string>\",\n        \"subtitle\": \"<string>\",\n        \"startButton\": \"<string>\",\n        \"logoAlt\": \"<string>\",\n        \"instructions\": [\n          {\n            \"icon\": \"<string>\",\n            \"title\": \"<string>\",\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"gameUI\": {\n        \"soundToggle\": {\n          \"enable\": \"<string>\",\n          \"disable\": \"<string>\"\n        },\n        \"pauseToggle\": {\n          \"pause\": \"<string>\",\n          \"resume\": \"<string>\"\n        }\n      },\n      \"modals\": {\n        \"win\": {\n          \"title\": \"<string>\",\n          \"subtitle\": \"<string>\",\n          \"homeButton\": \"<string>\",\n          \"closeButton\": \"<string>\"\n        },\n        \"lose\": {\n          \"title\": \"<string>\",\n          \"subtitle\": \"<string>\",\n          \"homeButton\": \"<string>\",\n          \"closeButton\": \"<string>\"\n        }\n      },\n      \"errors\": {\n        \"configurationError\": \"<string>\",\n        \"configurationErrorMessage\": \"<string>\",\n        \"retryButton\": \"<string>\",\n        \"imageLoadError\": \"<string>\"\n      },\n      \"accessibility\": {\n        \"playButton\": \"<string>\",\n        \"pauseButton\": \"<string>\",\n        \"homeButton\": \"<string>\",\n        \"progressIndicator\": \"<string>\"\n      },\n      \"status\": {\n        \"gameStarted\": \"<string>\",\n        \"win\": \"<string>\",\n        \"lose\": \"<string>\"\n      }\n    }\n  },\n  \"maxCompletionsPerPeriod\": 1,\n  \"details\": {\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"light\": {\n      \"primaryImageUrl\": \"<string>\",\n      \"secondaryImageUrl\": \"<string>\"\n    },\n    \"dark\": {\n      \"primaryImageUrl\": \"<string>\",\n      \"secondaryImageUrl\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://{subdomain}.nudj.cx/api/v2/admin/game-configs/{id}")
  .header("x-api-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": {\n    \"clientBranding\": {\n      \"gameTitle\": \"<string>\",\n      \"gameDescription\": \"<string>\",\n      \"clientName\": \"<string>\",\n      \"clientWebsite\": \"<string>\",\n      \"background\": {\n        \"image\": \"<string>\",\n        \"color\": \"<string>\"\n      },\n      \"logo\": {\n        \"url\": \"<string>\",\n        \"alt\": \"<string>\"\n      },\n      \"favicon\": \"<string>\",\n      \"font\": \"<string>\",\n      \"colors\": {\n        \"primary\": \"<string>\",\n        \"on-primary\": \"<string>\",\n        \"secondary\": \"<string>\",\n        \"on-secondary\": \"<string>\",\n        \"accent\": \"<string>\",\n        \"on-accent\": \"<string>\"\n      },\n      \"style\": {\n        \"cornerRadius\": 123\n      },\n      \"icons\": {\n        \"play\": \"<string>\",\n        \"pause\": \"<string>\",\n        \"restart\": \"<string>\",\n        \"home\": \"<string>\",\n        \"volume\": \"<string>\",\n        \"volume-off\": \"<string>\",\n        \"level-completed\": \"<string>\",\n        \"level-failed\": \"<string>\",\n        \"game-completed\": \"<string>\",\n        \"game-over\": \"<string>\",\n        \"star\": \"<string>\"\n      }\n    },\n    \"gameConfig\": {\n      \"game\": \"<string>\",\n      \"odds\": 0.5,\n      \"scratchCardImage\": \"<string>\",\n      \"backgroundImage\": \"<string>\",\n      \"productImages\": [\n        {\n          \"id\": \"<string>\",\n          \"url\": \"<string>\",\n          \"alt\": \"<string>\",\n          \"winning\": true,\n          \"distributionEventId\": \"<string>\"\n        }\n      ],\n      \"particlesColor\": \"<string>\",\n      \"cardColor\": \"<string>\",\n      \"cardGlowingColor\": \"<string>\",\n      \"cardTextColor\": \"<string>\",\n      \"sounds\": {\n        \"win\": \"<string>\",\n        \"lose\": \"<string>\"\n      }\n    },\n    \"textContent\": {\n      \"loading\": {\n        \"title\": \"<string>\",\n        \"subtitle\": \"<string>\",\n        \"progressText\": \"<string>\",\n        \"logoAlt\": \"<string>\"\n      },\n      \"home\": {\n        \"startButton\": \"<string>\",\n        \"loadingText\": \"<string>\",\n        \"preparingText\": \"<string>\",\n        \"features\": [\n          {\n            \"title\": \"<string>\",\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"tutorial\": {\n        \"title\": \"<string>\",\n        \"subtitle\": \"<string>\",\n        \"startButton\": \"<string>\",\n        \"logoAlt\": \"<string>\",\n        \"instructions\": [\n          {\n            \"icon\": \"<string>\",\n            \"title\": \"<string>\",\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"gameUI\": {\n        \"soundToggle\": {\n          \"enable\": \"<string>\",\n          \"disable\": \"<string>\"\n        },\n        \"pauseToggle\": {\n          \"pause\": \"<string>\",\n          \"resume\": \"<string>\"\n        }\n      },\n      \"modals\": {\n        \"win\": {\n          \"title\": \"<string>\",\n          \"subtitle\": \"<string>\",\n          \"homeButton\": \"<string>\",\n          \"closeButton\": \"<string>\"\n        },\n        \"lose\": {\n          \"title\": \"<string>\",\n          \"subtitle\": \"<string>\",\n          \"homeButton\": \"<string>\",\n          \"closeButton\": \"<string>\"\n        }\n      },\n      \"errors\": {\n        \"configurationError\": \"<string>\",\n        \"configurationErrorMessage\": \"<string>\",\n        \"retryButton\": \"<string>\",\n        \"imageLoadError\": \"<string>\"\n      },\n      \"accessibility\": {\n        \"playButton\": \"<string>\",\n        \"pauseButton\": \"<string>\",\n        \"homeButton\": \"<string>\",\n        \"progressIndicator\": \"<string>\"\n      },\n      \"status\": {\n        \"gameStarted\": \"<string>\",\n        \"win\": \"<string>\",\n        \"lose\": \"<string>\"\n      }\n    }\n  },\n  \"maxCompletionsPerPeriod\": 1,\n  \"details\": {\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"light\": {\n      \"primaryImageUrl\": \"<string>\",\n      \"secondaryImageUrl\": \"<string>\"\n    },\n    \"dark\": {\n      \"primaryImageUrl\": \"<string>\",\n      \"secondaryImageUrl\": \"<string>\"\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{subdomain}.nudj.cx/api/v2/admin/game-configs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config\": {\n    \"clientBranding\": {\n      \"gameTitle\": \"<string>\",\n      \"gameDescription\": \"<string>\",\n      \"clientName\": \"<string>\",\n      \"clientWebsite\": \"<string>\",\n      \"background\": {\n        \"image\": \"<string>\",\n        \"color\": \"<string>\"\n      },\n      \"logo\": {\n        \"url\": \"<string>\",\n        \"alt\": \"<string>\"\n      },\n      \"favicon\": \"<string>\",\n      \"font\": \"<string>\",\n      \"colors\": {\n        \"primary\": \"<string>\",\n        \"on-primary\": \"<string>\",\n        \"secondary\": \"<string>\",\n        \"on-secondary\": \"<string>\",\n        \"accent\": \"<string>\",\n        \"on-accent\": \"<string>\"\n      },\n      \"style\": {\n        \"cornerRadius\": 123\n      },\n      \"icons\": {\n        \"play\": \"<string>\",\n        \"pause\": \"<string>\",\n        \"restart\": \"<string>\",\n        \"home\": \"<string>\",\n        \"volume\": \"<string>\",\n        \"volume-off\": \"<string>\",\n        \"level-completed\": \"<string>\",\n        \"level-failed\": \"<string>\",\n        \"game-completed\": \"<string>\",\n        \"game-over\": \"<string>\",\n        \"star\": \"<string>\"\n      }\n    },\n    \"gameConfig\": {\n      \"game\": \"<string>\",\n      \"odds\": 0.5,\n      \"scratchCardImage\": \"<string>\",\n      \"backgroundImage\": \"<string>\",\n      \"productImages\": [\n        {\n          \"id\": \"<string>\",\n          \"url\": \"<string>\",\n          \"alt\": \"<string>\",\n          \"winning\": true,\n          \"distributionEventId\": \"<string>\"\n        }\n      ],\n      \"particlesColor\": \"<string>\",\n      \"cardColor\": \"<string>\",\n      \"cardGlowingColor\": \"<string>\",\n      \"cardTextColor\": \"<string>\",\n      \"sounds\": {\n        \"win\": \"<string>\",\n        \"lose\": \"<string>\"\n      }\n    },\n    \"textContent\": {\n      \"loading\": {\n        \"title\": \"<string>\",\n        \"subtitle\": \"<string>\",\n        \"progressText\": \"<string>\",\n        \"logoAlt\": \"<string>\"\n      },\n      \"home\": {\n        \"startButton\": \"<string>\",\n        \"loadingText\": \"<string>\",\n        \"preparingText\": \"<string>\",\n        \"features\": [\n          {\n            \"title\": \"<string>\",\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"tutorial\": {\n        \"title\": \"<string>\",\n        \"subtitle\": \"<string>\",\n        \"startButton\": \"<string>\",\n        \"logoAlt\": \"<string>\",\n        \"instructions\": [\n          {\n            \"icon\": \"<string>\",\n            \"title\": \"<string>\",\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"gameUI\": {\n        \"soundToggle\": {\n          \"enable\": \"<string>\",\n          \"disable\": \"<string>\"\n        },\n        \"pauseToggle\": {\n          \"pause\": \"<string>\",\n          \"resume\": \"<string>\"\n        }\n      },\n      \"modals\": {\n        \"win\": {\n          \"title\": \"<string>\",\n          \"subtitle\": \"<string>\",\n          \"homeButton\": \"<string>\",\n          \"closeButton\": \"<string>\"\n        },\n        \"lose\": {\n          \"title\": \"<string>\",\n          \"subtitle\": \"<string>\",\n          \"homeButton\": \"<string>\",\n          \"closeButton\": \"<string>\"\n        }\n      },\n      \"errors\": {\n        \"configurationError\": \"<string>\",\n        \"configurationErrorMessage\": \"<string>\",\n        \"retryButton\": \"<string>\",\n        \"imageLoadError\": \"<string>\"\n      },\n      \"accessibility\": {\n        \"playButton\": \"<string>\",\n        \"pauseButton\": \"<string>\",\n        \"homeButton\": \"<string>\",\n        \"progressIndicator\": \"<string>\"\n      },\n      \"status\": {\n        \"gameStarted\": \"<string>\",\n        \"win\": \"<string>\",\n        \"lose\": \"<string>\"\n      }\n    }\n  },\n  \"maxCompletionsPerPeriod\": 1,\n  \"details\": {\n    \"title\": \"<string>\",\n    \"description\": \"<string>\",\n    \"light\": {\n      \"primaryImageUrl\": \"<string>\",\n      \"secondaryImageUrl\": \"<string>\"\n    },\n    \"dark\": {\n      \"primaryImageUrl\": \"<string>\",\n      \"secondaryImageUrl\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "organisationId": "<string>",
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "config": {
    "clientBranding": {
      "gameTitle": "<string>",
      "gameDescription": "<string>",
      "clientName": "<string>",
      "clientWebsite": "<string>",
      "background": {
        "image": "<string>",
        "color": "<string>"
      },
      "logo": {
        "url": "<string>",
        "alt": "<string>"
      },
      "favicon": "<string>",
      "font": "<string>",
      "colors": {
        "primary": "<string>",
        "on-primary": "<string>",
        "secondary": "<string>",
        "on-secondary": "<string>",
        "accent": "<string>",
        "on-accent": "<string>"
      },
      "style": {
        "cornerRadius": 123
      },
      "icons": {
        "play": "<string>",
        "pause": "<string>",
        "restart": "<string>",
        "home": "<string>",
        "volume": "<string>",
        "volume-off": "<string>",
        "level-completed": "<string>",
        "level-failed": "<string>",
        "game-completed": "<string>",
        "game-over": "<string>",
        "star": "<string>"
      }
    },
    "gameConfig": {
      "game": "<string>",
      "odds": 0.5,
      "scratchCardImage": "<string>",
      "backgroundImage": "<string>",
      "productImages": [
        {
          "id": "<string>",
          "url": "<string>",
          "alt": "<string>",
          "winning": true,
          "distributionEventId": "<string>"
        }
      ],
      "particlesColor": "<string>",
      "cardColor": "<string>",
      "cardGlowingColor": "<string>",
      "cardTextColor": "<string>",
      "sounds": {
        "win": "<string>",
        "lose": "<string>"
      }
    },
    "textContent": {
      "loading": {
        "title": "<string>",
        "subtitle": "<string>",
        "progressText": "<string>",
        "logoAlt": "<string>"
      },
      "home": {
        "startButton": "<string>",
        "loadingText": "<string>",
        "preparingText": "<string>",
        "features": [
          {
            "title": "<string>",
            "description": "<string>"
          }
        ]
      },
      "tutorial": {
        "title": "<string>",
        "subtitle": "<string>",
        "startButton": "<string>",
        "logoAlt": "<string>",
        "instructions": [
          {
            "icon": "<string>",
            "title": "<string>",
            "description": "<string>"
          }
        ]
      },
      "gameUI": {
        "soundToggle": {
          "enable": "<string>",
          "disable": "<string>"
        },
        "pauseToggle": {
          "pause": "<string>",
          "resume": "<string>"
        }
      },
      "modals": {
        "win": {
          "title": "<string>",
          "subtitle": "<string>",
          "homeButton": "<string>",
          "closeButton": "<string>"
        },
        "lose": {
          "title": "<string>",
          "subtitle": "<string>",
          "homeButton": "<string>",
          "closeButton": "<string>"
        }
      },
      "errors": {
        "configurationError": "<string>",
        "configurationErrorMessage": "<string>",
        "retryButton": "<string>",
        "imageLoadError": "<string>"
      },
      "accessibility": {
        "playButton": "<string>",
        "pauseButton": "<string>",
        "homeButton": "<string>",
        "progressIndicator": "<string>"
      },
      "status": {
        "gameStarted": "<string>",
        "win": "<string>",
        "lose": "<string>"
      }
    }
  },
  "createdAt": "<string>",
  "rewardDistributions": [
    {
      "points": 1,
      "xp": 1,
      "distributionEventId": "<string>",
      "rewardAllocations": [
        {
          "rewardId": "<string>",
          "allocationId": "<string>",
          "amountToDistribute": 2
        }
      ],
      "numberOfRewardsToReceive": 1
    }
  ],
  "maxCompletionsPerPeriod": 1,
  "updatedAt": "<string>"
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to update the game config in. Language-specific fields will be applied only for that language.

Path Parameters

​
id
string
required

The id of the game configuration to update

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

The input required to update a game configuration

​
config
object

Full game configuration including client branding, game-specific config, and text content

​
progressPeriod
enum<string>

The progress period for repeat limits

Available options:
daily,
weekly,
monthly,
yearly,
open
​
maxCompletionsPerPeriod

The maximum number of times this game can be completed per period

Required range: x >= 0
​
details
Details Update Input · object

Input for updating entity details with all fields optional

Response

Successful response

A Nudj game configuration

​
id
string
required

The id of the game configuration

Pattern: ^[0-9a-fA-F]{24}$
​
organisationId
string
required

The organisation that the game configuration belongs to

Pattern: ^[0-9a-fA-F]{24}$
​
details
Details · object
required

The details of this game configuration such as title and description

​
gameType
enum<string>
required

The type of game

Available options:
catch,
memory,
scratch
​
config
object
required

Full game configuration including client branding, game-specific config, and text content

​
createdAt
string
required

The date when this game configuration was created

​
rewardDistributions
Entity Reward Distribution · object[] | null
required

The reward distributions (prizes) for this game configuration

​
progressPeriod
enum<string>
required

The progress period for repeat limits

Available options:
daily,
weekly,
monthly,
yearly,
open
​
maxCompletionsPerPeriod
required

The maximum number of times this game can be completed per period

Required range: x >= 0
​
updatedAt
string

The date when this game configuration was last updated