Promo Code Exception Lists

Endpoints for retrieving promo code exception list details and items.

Retrieve a Promo Code Exception List

get

Retrieves the details of an existing promo code exception list using its unique ID. The PromoCodeExceptionListId can be obtained from the Contracts API.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

PromoCodeExceptionListIdstringRequired

The unique identifier for the promo code exception list.

Responses

200

The promo code exception list object.

application/json

IdstringOptional

Unique identifier for the promo code exception list.

Example: 6001

NamestringOptional

Display name of the promo code exception list.

Example: VIP Partner Promo Exclusions

Statestring · enumOptional

The current state of the promo code exception list.

Example: ACTIVEPossible values:

CampaignIdstringOptional

Unique identifier for the program this promo code exception list applies to.

Example: 10306

CreatedDatestring · date-timeOptional

Date and time the promo code exception list was created (ISO 8601).

Example: 2024-03-10T09:00:00-08:00

DeactivationDatestring · date-timeOptional

Date and time the promo code exception list was deactivated (ISO 8601). Empty if the list is still active.

NumberOfItemsintegerOptional

The number of items in the promo code exception list.

Example: 5

ItemsUristringOptional

API resource path for retrieving the items in this promo code exception list.

Example: /Mediapartners/<AccountSID>/PromoCodeExceptionLists/6001/Items

UristringOptional

Unique reference to the promo code exception list object in the impact.com API.

Example: /Mediapartners/<AccountSID>/PromoCodeExceptionLists/6001

get/Mediapartners/{AccountSID}/PromoCodeExceptionLists/{PromoCodeExceptionListId}

HTTPcURLJavaScriptPython

GET /Mediapartners/{AccountSID}/PromoCodeExceptionLists/{PromoCodeExceptionListId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

The promo code exception list object.

{
  "Id": "6001",
  "Name": "VIP Partner Promo Exclusions",
  "State": "ACTIVE",
  "CampaignId": "10306",
  "CreatedDate": "2024-03-10T09:00:00-08:00",
  "DeactivationDate": "",
  "NumberOfItems": 5,
  "ItemsUri": "/Mediapartners/<AccountSID>/PromoCodeExceptionLists/6001/Items",
  "Uri": "/Mediapartners/<AccountSID>/PromoCodeExceptionLists/6001"
}

List Promo Code Exception List Items

get

Returns a list of all items in a specific promo code exception list. Each item defines a promo code value that triggers an alternate commission rate.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

PromoCodeExceptionListIdstringRequired

The unique identifier for the promo code exception list whose items are being retrieved.

Responses

200

A list of promo code exception list item objects.

application/json

get/Mediapartners/{AccountSID}/PromoCodeExceptionLists/{PromoCodeExceptionListId}/Items

HTTPcURLJavaScriptPython

GET /Mediapartners/{AccountSID}/PromoCodeExceptionLists/{PromoCodeExceptionListId}/Items HTTP/1.1
Host: api.impact.com
Accept: */*

200

A list of promo code exception list item objects.

{
  "PromoCodeExceptionListItems": [
    {
      "Id": "1",
      "ListId": "6001",
      "Name": "Summer Sale Code",
      "Value": "SUMMER2026",
      "MatchMode": "EQ",
      "CreatedDate": "2024-03-10T09:00:00-08:00",
      "Uri": "/Mediapartners/<AccountSID>/PromoCodeExceptionLists/6001/Items/1"
    }
  ]
}