Update Coupon Configurations

cURL

curl --request PUT \
  --url https://api.gameball.co/api/v4.0/integrations/configurations/coupon \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>' \
  --data '
{
  "url": "https://api.mywebsite.com/coupons",
  "method": "POST",
  "queryParams": [
    {
      "key": "appId",
      "value": "12345"
    }
  ],
  "headers": [
    {
      "key": "X-Client-Version",
      "value": "1.0"
    }
  ],
  "payload": "{ \"couponCode\": \"DISCOUNT10\" }",
  "couponMapping": {
    "fixed": "fixed_discount",
    "percentage": "percentage_discount",
    "freeProduct": "free_product",
    "freeShipping": "free_delivery"
  },
  "enableFreeProduct": true,
  "enableFixedRate": true,
  "enableFreeShipping": true,
  "enablePercentage": true,
  "platforms": [
    {
      "displayName": "<string>",
      "value": "<string>"
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {
    apikey: '<api-key>',
    secretkey: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://api.mywebsite.com/coupons',
    method: 'POST',
    queryParams: [{key: 'appId', value: '12345'}],
    headers: [{key: 'X-Client-Version', value: '1.0'}],
    payload: '{ "couponCode": "DISCOUNT10" }',
    couponMapping: {
      fixed: 'fixed_discount',
      percentage: 'percentage_discount',
      freeProduct: 'free_product',
      freeShipping: 'free_delivery'
    },
    enableFreeProduct: true,
    enableFixedRate: true,
    enableFreeShipping: true,
    enablePercentage: true,
    platforms: [{displayName: '<string>', value: '<string>'}]
  })
};

fetch('https://api.gameball.co/api/v4.0/integrations/configurations/coupon', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.gameball.co/api/v4.0/integrations/configurations/coupon"

payload = {
    "url": "https://api.mywebsite.com/coupons",
    "method": "POST",
    "queryParams": [
        {
            "key": "appId",
            "value": "12345"
        }
    ],
    "headers": [
        {
            "key": "X-Client-Version",
            "value": "1.0"
        }
    ],
    "payload": "{ \"couponCode\": \"DISCOUNT10\" }",
    "couponMapping": {
        "fixed": "fixed_discount",
        "percentage": "percentage_discount",
        "freeProduct": "free_product",
        "freeShipping": "free_delivery"
    },
    "enableFreeProduct": True,
    "enableFixedRate": True,
    "enableFreeShipping": True,
    "enablePercentage": True,
    "platforms": [
        {
            "displayName": "<string>",
            "value": "<string>"
        }
    ]
}
headers = {
    "apikey": "<api-key>",
    "secretkey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.gameball.co/api/v4.0/integrations/configurations/coupon");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
request.AddHeader("secretkey", "<api-key>");
request.AddJsonBody("{\n  \"url\": \"https://api.mywebsite.com/coupons\",\n  \"method\": \"POST\",\n  \"queryParams\": [\n    {\n      \"key\": \"appId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"headers\": [\n    {\n      \"key\": \"X-Client-Version\",\n      \"value\": \"1.0\"\n    }\n  ],\n  \"payload\": \"{ \\\"couponCode\\\": \\\"DISCOUNT10\\\" }\",\n  \"couponMapping\": {\n    \"fixed\": \"fixed_discount\",\n    \"percentage\": \"percentage_discount\",\n    \"freeProduct\": \"free_product\",\n    \"freeShipping\": \"free_delivery\"\n  },\n  \"enableFreeProduct\": true,\n  \"enableFixedRate\": true,\n  \"enableFreeShipping\": true,\n  \"enablePercentage\": true,\n  \"platforms\": [\n    {\n      \"displayName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

package main

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

func main() {

	url := "https://api.gameball.co/api/v4.0/integrations/configurations/coupon"

	payload := strings.NewReader("{\n  \"url\": \"https://api.mywebsite.com/coupons\",\n  \"method\": \"POST\",\n  \"queryParams\": [\n    {\n      \"key\": \"appId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"headers\": [\n    {\n      \"key\": \"X-Client-Version\",\n      \"value\": \"1.0\"\n    }\n  ],\n  \"payload\": \"{ \\\"couponCode\\\": \\\"DISCOUNT10\\\" }\",\n  \"couponMapping\": {\n    \"fixed\": \"fixed_discount\",\n    \"percentage\": \"percentage_discount\",\n    \"freeProduct\": \"free_product\",\n    \"freeShipping\": \"free_delivery\"\n  },\n  \"enableFreeProduct\": true,\n  \"enableFixedRate\": true,\n  \"enableFreeShipping\": true,\n  \"enablePercentage\": true,\n  \"platforms\": [\n    {\n      \"displayName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("secretkey", "<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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gameball.co/api/v4.0/integrations/configurations/coupon",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://api.mywebsite.com/coupons',
    'method' => 'POST',
    'queryParams' => [
        [
                'key' => 'appId',
                'value' => '12345'
        ]
    ],
    'headers' => [
        [
                'key' => 'X-Client-Version',
                'value' => '1.0'
        ]
    ],
    'payload' => '{ "couponCode": "DISCOUNT10" }',
    'couponMapping' => [
        'fixed' => 'fixed_discount',
        'percentage' => 'percentage_discount',
        'freeProduct' => 'free_product',
        'freeShipping' => 'free_delivery'
    ],
    'enableFreeProduct' => true,
    'enableFixedRate' => true,
    'enableFreeShipping' => true,
    'enablePercentage' => true,
    'platforms' => [
        [
                'displayName' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>",
    "secretkey: <api-key>"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.put("https://api.gameball.co/api/v4.0/integrations/configurations/coupon")
  .header("apikey", "<api-key>")
  .header("secretkey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://api.mywebsite.com/coupons\",\n  \"method\": \"POST\",\n  \"queryParams\": [\n    {\n      \"key\": \"appId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"headers\": [\n    {\n      \"key\": \"X-Client-Version\",\n      \"value\": \"1.0\"\n    }\n  ],\n  \"payload\": \"{ \\\"couponCode\\\": \\\"DISCOUNT10\\\" }\",\n  \"couponMapping\": {\n    \"fixed\": \"fixed_discount\",\n    \"percentage\": \"percentage_discount\",\n    \"freeProduct\": \"free_product\",\n    \"freeShipping\": \"free_delivery\"\n  },\n  \"enableFreeProduct\": true,\n  \"enableFixedRate\": true,\n  \"enableFreeShipping\": true,\n  \"enablePercentage\": true,\n  \"platforms\": [\n    {\n      \"displayName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

PUT

api

v4.0

integrations

configurations

coupon

cURL

curl --request PUT \
  --url https://api.gameball.co/api/v4.0/integrations/configurations/coupon \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>' \
  --data '
{
  "url": "https://api.mywebsite.com/coupons",
  "method": "POST",
  "queryParams": [
    {
      "key": "appId",
      "value": "12345"
    }
  ],
  "headers": [
    {
      "key": "X-Client-Version",
      "value": "1.0"
    }
  ],
  "payload": "{ \"couponCode\": \"DISCOUNT10\" }",
  "couponMapping": {
    "fixed": "fixed_discount",
    "percentage": "percentage_discount",
    "freeProduct": "free_product",
    "freeShipping": "free_delivery"
  },
  "enableFreeProduct": true,
  "enableFixedRate": true,
  "enableFreeShipping": true,
  "enablePercentage": true,
  "platforms": [
    {
      "displayName": "<string>",
      "value": "<string>"
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {
    apikey: '<api-key>',
    secretkey: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://api.mywebsite.com/coupons',
    method: 'POST',
    queryParams: [{key: 'appId', value: '12345'}],
    headers: [{key: 'X-Client-Version', value: '1.0'}],
    payload: '{ "couponCode": "DISCOUNT10" }',
    couponMapping: {
      fixed: 'fixed_discount',
      percentage: 'percentage_discount',
      freeProduct: 'free_product',
      freeShipping: 'free_delivery'
    },
    enableFreeProduct: true,
    enableFixedRate: true,
    enableFreeShipping: true,
    enablePercentage: true,
    platforms: [{displayName: '<string>', value: '<string>'}]
  })
};

fetch('https://api.gameball.co/api/v4.0/integrations/configurations/coupon', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.gameball.co/api/v4.0/integrations/configurations/coupon"

payload = {
    "url": "https://api.mywebsite.com/coupons",
    "method": "POST",
    "queryParams": [
        {
            "key": "appId",
            "value": "12345"
        }
    ],
    "headers": [
        {
            "key": "X-Client-Version",
            "value": "1.0"
        }
    ],
    "payload": "{ \"couponCode\": \"DISCOUNT10\" }",
    "couponMapping": {
        "fixed": "fixed_discount",
        "percentage": "percentage_discount",
        "freeProduct": "free_product",
        "freeShipping": "free_delivery"
    },
    "enableFreeProduct": True,
    "enableFixedRate": True,
    "enableFreeShipping": True,
    "enablePercentage": True,
    "platforms": [
        {
            "displayName": "<string>",
            "value": "<string>"
        }
    ]
}
headers = {
    "apikey": "<api-key>",
    "secretkey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.gameball.co/api/v4.0/integrations/configurations/coupon");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
request.AddHeader("secretkey", "<api-key>");
request.AddJsonBody("{\n  \"url\": \"https://api.mywebsite.com/coupons\",\n  \"method\": \"POST\",\n  \"queryParams\": [\n    {\n      \"key\": \"appId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"headers\": [\n    {\n      \"key\": \"X-Client-Version\",\n      \"value\": \"1.0\"\n    }\n  ],\n  \"payload\": \"{ \\\"couponCode\\\": \\\"DISCOUNT10\\\" }\",\n  \"couponMapping\": {\n    \"fixed\": \"fixed_discount\",\n    \"percentage\": \"percentage_discount\",\n    \"freeProduct\": \"free_product\",\n    \"freeShipping\": \"free_delivery\"\n  },\n  \"enableFreeProduct\": true,\n  \"enableFixedRate\": true,\n  \"enableFreeShipping\": true,\n  \"enablePercentage\": true,\n  \"platforms\": [\n    {\n      \"displayName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

package main

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

func main() {

	url := "https://api.gameball.co/api/v4.0/integrations/configurations/coupon"

	payload := strings.NewReader("{\n  \"url\": \"https://api.mywebsite.com/coupons\",\n  \"method\": \"POST\",\n  \"queryParams\": [\n    {\n      \"key\": \"appId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"headers\": [\n    {\n      \"key\": \"X-Client-Version\",\n      \"value\": \"1.0\"\n    }\n  ],\n  \"payload\": \"{ \\\"couponCode\\\": \\\"DISCOUNT10\\\" }\",\n  \"couponMapping\": {\n    \"fixed\": \"fixed_discount\",\n    \"percentage\": \"percentage_discount\",\n    \"freeProduct\": \"free_product\",\n    \"freeShipping\": \"free_delivery\"\n  },\n  \"enableFreeProduct\": true,\n  \"enableFixedRate\": true,\n  \"enableFreeShipping\": true,\n  \"enablePercentage\": true,\n  \"platforms\": [\n    {\n      \"displayName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("secretkey", "<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))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gameball.co/api/v4.0/integrations/configurations/coupon",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://api.mywebsite.com/coupons',
    'method' => 'POST',
    'queryParams' => [
        [
                'key' => 'appId',
                'value' => '12345'
        ]
    ],
    'headers' => [
        [
                'key' => 'X-Client-Version',
                'value' => '1.0'
        ]
    ],
    'payload' => '{ "couponCode": "DISCOUNT10" }',
    'couponMapping' => [
        'fixed' => 'fixed_discount',
        'percentage' => 'percentage_discount',
        'freeProduct' => 'free_product',
        'freeShipping' => 'free_delivery'
    ],
    'enableFreeProduct' => true,
    'enableFixedRate' => true,
    'enableFreeShipping' => true,
    'enablePercentage' => true,
    'platforms' => [
        [
                'displayName' => '<string>',
                'value' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>",
    "secretkey: <api-key>"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.put("https://api.gameball.co/api/v4.0/integrations/configurations/coupon")
  .header("apikey", "<api-key>")
  .header("secretkey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://api.mywebsite.com/coupons\",\n  \"method\": \"POST\",\n  \"queryParams\": [\n    {\n      \"key\": \"appId\",\n      \"value\": \"12345\"\n    }\n  ],\n  \"headers\": [\n    {\n      \"key\": \"X-Client-Version\",\n      \"value\": \"1.0\"\n    }\n  ],\n  \"payload\": \"{ \\\"couponCode\\\": \\\"DISCOUNT10\\\" }\",\n  \"couponMapping\": {\n    \"fixed\": \"fixed_discount\",\n    \"percentage\": \"percentage_discount\",\n    \"freeProduct\": \"free_product\",\n    \"freeShipping\": \"free_delivery\"\n  },\n  \"enableFreeProduct\": true,\n  \"enableFixedRate\": true,\n  \"enableFreeShipping\": true,\n  \"enablePercentage\": true,\n  \"platforms\": [\n    {\n      \"displayName\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

Update Coupon Configurations

This API call updates your coupon configurations, allowing you to modify details about how coupons are structured, authenticated, and mapped within Gameball.

Security: Provide both apikey and secretkey headers.

Authorizations

apikey

string

header

required

secretkey

string

header

required

Body

application/json

url

string

required

The URL of your API endpoint where coupons are created. Gameball will send requests to this endpoint whenever a coupon needs to be generated.

Example:

"https://api.mywebsite.com/coupons"

method

string

required

The HTTP method used to send requests to the coupon creation endpoint. Allowed values are POST, PUT or GET.

Example:

"POST"

queryParams

object[]

List of query parameters used in the request. Those that will be appended to the URL endpoint. These are used to pass specific parameters required by your coupon system as part of the URL itself, often for identification, filtering, or configuration purposes. Each query parameter is defined by a key-value pair, allowing you to tailor requests based on requirements in your API.

Show child attributes

headers

object[]

List of headers used in the request.

Show child attributes

payload

string

This specifies the structure of the JSON body Gameball will send to your endpoint when creating a coupon. Since different systems may use varying parameter names and structures, you can customize this payload to align with your system's requirements. You should define the JSON payload with placeholders that Gameball will replace with actual data when sending the request. Example: { "customerId": "{{playerUniqueId}}", "amount": "{{value}}", "code": "{{code}}" }

Example:

"{ \"couponCode\": \"DISCOUNT10\" }"

couponMapping

object

A dictionary mapping coupon attributes to specific keys in your system.

Show child attributes

enableFreeProduct

boolean

Indicates whether free product coupons are enabled.

Example:

true

enableFixedRate

boolean

Indicates whether fixed-rate discount coupons are enabled.

Example:

true

enableFreeShipping

boolean

Indicates whether free shipping coupons are enabled.

Example:

true

enablePercentage

boolean

Indicates whether percentage-based discount coupons are enabled.

Example:

true

platforms

object[]

List of platforms for which the coupon configurations are applied in your system.

Show child attributes

Response

200

Coupon configurations updated successfully

API documentation

Webhooks

Update Coupon Configurations

Update Coupon Configurations

Authorizations

Body

Response

​Update Coupon Configurations

Authorizations

Body

Response

Update Coupon Configurations