Suggests promotion codes built from the values the caller has filled in so far.

POST /api/promotions/suggest-codes deprecated

Requires: Promotions.Promotions, merchant scope.

Memorable codes are guessable by design: they are marketing codes a customer reads off a flyer. Ask for the private style for a single-use or goodwill discount. Nothing is stored; a suggestion becomes a promotion only when it is created.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a SuggestPromotionCodesInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/promotions/suggest-codes" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "style": {},
  "count": 1,
  "discountType": {},
  "value": 0,
  "currency": "",
  "name": "",
  "startsAtUtc": "2026-01-01T00:00:00Z",
  "appliesToScope": {},
  "durationMode": {},
  "durationCycles": 0
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "style": {},
  "count": 1,
  "discountType": {},
  "value": 0,
  "currency": "",
  "name": "",
  "startsAtUtc": "2026-01-01T00:00:00Z",
  "appliesToScope": {},
  "durationMode": {},
  "durationCycles": 0
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/promotions/suggest-codes' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, PromotionsApi } from '@winkpg/winkpg-api';

const api = new PromotionsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.promotionsSuggestCodes({
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "style": {},
  "count": 1,
  "discountType": {},
  "value": 0,
  "currency": "",
  "name": "",
  "startsAtUtc": "2026-01-01T00:00:00Z",
  "appliesToScope": {},
  "durationMode": {},
  "durationCycles": 0
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/promotions/suggest-codes', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "style": {},
    "count": 1,
    "discountType": {},
    "value": 0,
    "currency": "",
    "name": "",
    "startsAtUtc": "2026-01-01T00:00:00Z",
    "appliesToScope": {},
    "durationMode": {},
    "durationCycles": 0
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new PromotionsApi(config);
var body = JsonSerializer.Deserialize<SuggestPromotionCodesInput>("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "style": {},
      "count": 1,
      "discountType": {},
      "value": 0,
      "currency": "",
      "name": "",
      "startsAtUtc": "2026-01-01T00:00:00Z",
      "appliesToScope": {},
      "durationMode": {},
      "durationCycles": 0
    }
    """);

var result = await api.PromotionsSuggestCodesAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/promotions/suggest-codes");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "style": {},
      "count": 1,
      "discountType": {},
      "value": 0,
      "currency": "",
      "name": "",
      "startsAtUtc": "2026-01-01T00:00:00Z",
      "appliesToScope": {},
      "durationMode": {},
      "durationCycles": 0
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.PromotionsApi(client)
    body = winkpg_api.SuggestPromotionCodesInput.from_dict({
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "style": {},
      "count": 1,
      "discountType": {},
      "value": 0,
      "currency": "",
      "name": "",
      "startsAtUtc": "2026-01-01T00:00:00Z",
      "appliesToScope": {},
      "durationMode": {},
      "durationCycles": 0
    })
    result = api.promotions_suggest_codes(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "excludePromotionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "style": {},
  "count": 1,
  "discountType": {},
  "value": 0,
  "currency": "",
  "name": "",
  "startsAtUtc": "2026-01-01T00:00:00Z",
  "appliesToScope": {},
  "durationMode": {},
  "durationCycles": 0
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/promotions/suggest-codes",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`merchantId` required	string (uuid)	The merchant the promotion will belong to. When given, codes the merchant already uses are left out of the suggestions. The caller must be authorized over the merchant. Conditional: When MerchantId is not null. nullable
`excludePromotionId` required	string (uuid)	The promotion being edited, so its own current code is not treated as taken. nullable
`style` required	all of PromotionCodeSuggestionStyle	Memorable marketing codes, or private single-use ones.
`count` required	integer (int32)	How many suggestions to return, between 1 and `MaxCount`. min 1max 10
`discountType` required	all of PromotionDiscountType	Whether the value is a percentage or a flat amount. nullable
`value` required	number (double)	The percentage, or the flat amount. nullable
`currency` required	string	The ISO 4217 currency, when the promotion has one. nullable
`name` required	string	The operator-facing promotion name. Its first word may appear in a suggestion. nullablemax length 128
`startsAtUtc` required	string (date-time)	When the promotion starts. The season and month in a suggestion are read from it. nullable
`appliesToScope` required	all of PromotionAppliesToScope	What the promotion applies to. nullable
`durationMode` required	all of PromotionDurationMode	How long the discount runs on a recurring charge. nullable
`durationCycles` required	integer (int32)	How many billing cycles the discount runs for. nullable

This request body has no documented fields.