---
title: "PUT /api/v4.0/integrations/configurations/coupon"
method: PUT
path: "/api/v4.0/integrations/configurations/coupon"
---

# PUT /api/v4.0/integrations/configurations/coupon

`PUT /api/v4.0/integrations/configurations/coupon`

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

## Request body

- object
  - `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.
  - `method` string, required — The HTTP method used to send requests to the coupon creation endpoint. Allowed values are POST, PUT or GET.
  - `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.
    - `key` string, required — The key used in the query parameter.
    - `value` string, required — The value of the query parameter.
  - `headers` object[] — List of headers used in the request.
    - `key` string, required — The header key.
    - `value` string, required — The header value.
  - `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}}" }
  - `couponMapping` object — A dictionary mapping coupon attributes to specific keys in your system.
    - `fixed` string — The internal naming for the fixed discount codes in your system.
    - `percentage` string — The internal naming for the percentage discount codes in your system.
    - `freeProduct` string — The internal naming for the free product discount codes in your system.
    - `freeShipping` string — The internal naming for the free shipping discount codes in your system.
  - `enableFreeProduct` boolean — Indicates whether free product coupons are enabled.
  - `enableFixedRate` boolean — Indicates whether fixed-rate discount coupons are enabled.
  - `enableFreeShipping` boolean — Indicates whether free shipping coupons are enabled.
  - `enablePercentage` boolean — Indicates whether percentage-based discount coupons are enabled.
  - `platforms` object[] — List of platforms for which the coupon configurations are applied in your system.
    - `displayName` string, required — The display name of the platform.
    - `value` string, required — The internal value used for the platform.

## Response `200`

Coupon configurations updated successfully

---

[API](https://skmtc.net/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.net/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gameballers/gameball-api/versions/2e4a8bfe2291/schema)