Promo Codes

Endpoints for listing and retrieving brand-issued promo codes available to your partner account.

List Promo Codes

get

Returns the promo codes available to your partner account. Supports filtering by program, advertiser, deal, credit rule, match mode, and creation date range.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters

SearchStringstringOptional

Free-text search across all promo code fields.

ProgramIdstring[]Optional

Filter by one or more program IDs.

AdvertiserIdstring[]Optional

Filter by one or more advertiser (brand) IDs.

DealIdstring[]Optional

Filter by one or more deal IDs.

CreatedDateStartstring · date-timeOptional

Return only codes created on or after this date/time (ISO 8601).

CreatedDateEndstring · date-timeOptional

Return only codes created on or before this date/time (ISO 8601).

StartDateStartstring · date-timeOptional

Return only promo codes whose StartDate is on or after this date/time (ISO 8601).

StartDateEndstring · date-timeOptional

Return only promo codes whose StartDate is on or before this date/time (ISO 8601).

EndDateStartstring · date-timeOptional

Return only promo codes whose EndDate is on or after this date/time (ISO 8601).

EndDateEndstring · date-timeOptional

Return only promo codes whose EndDate is on or before this date/time (ISO 8601).

Responses

200

A list of promo code objects.

application/json

get/Mediapartners/{AccountSID}/PromoCodes

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/PromoCodes' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

A list of promo code objects.

{
  "PromoCodes": [
    {
      "Id": "8111554",
      "Code": "HAZEL10OFF",
      "State": "ACTIVE",
      "Program": {
        "Id": "21282",
        "Name": "Acme's Creator Program",
        "Uri": "/Mediapartners/<AccountSID>/Campaigns/21282",
        "LogoUri": "/Mediapartners/<AccountSID>/Campaigns/21282/Logo"
      },
      "Advertiser": {
        "Id": "1804207",
        "Name": "Acme Corporation",
        "Uri": "/Mediapartners/<AccountSID>/Advertisers/1804207",
        "LogoUri": "/Mediapartners/<AccountSID>/Advertisers/1804207/Logo"
      },
      "Deal": {
        "Id": "92812",
        "Name": "Summer Promotion",
        "Uri": "/Mediapartners/<AccountSID>/Campaigns/10306/Deals/92812"
      },
      "MatchMode": "LI",
      "CreditRule": "ALWAYS",
      "CreatedDate": "2023-12-12T03:28:40-08:00",
      "StartDate": "2026-01-01T00:00:00-08:00",
      "EndDate": "2026-01-31T23:59:59-08:00",
      "Uri": "/Mediapartners/<AccountSID>/PromoCodes/8111554"
    }
  ]
}

Retrieve a Promo Code

get

Returns the full details of a single promo code by its unique Id.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

The unique identifier assigned to the promo code.

Responses

200

A single promo code object.

application/json

IdstringOptional

Unique identifier assigned to the promo code.

Example: 8111554

CodestringOptional

The alphanumeric string customers enter at checkout to redeem the offer.

Example: HAZEL10OFF

Statestring · enumOptional

Current state of the promo code.

Example: ACTIVEPossible values:

MatchModestring · enumOptional

How the promo code value is matched against codes used at checkout.

• LI: Literal — the code must match exactly.
• RE: Regex — the code is interpreted as a regular expression.

Possible values:

CreditRulestring · enumOptional

When the partner is credited for a conversion that used this code.

• ALWAYS: The partner is always credited.
• INVOLVED: Credited only when involved in the click path leading to the sale.
• WINNER: Credited only when the partner drove the last click before the sale.

Possible values:

CreatedDatestring · date-timeOptional

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

Example: 2023-12-12T03:28:40-08:00

StartDatestring · date-timeOptional

Date and time the promo code becomes active (ISO 8601). Only returned when the code is scheduled with a start date.

Example: 2026-01-01T00:00:00-08:00

EndDatestring · date-timeOptional

Date and time the promo code expires (ISO 8601). Only returned when the code is scheduled with an end date.

Example: 2026-01-31T23:59:59-08:00

Uristring · uriOptional

API resource path for this promo code.

Example: /Mediapartners/<AccountSID>/PromoCodes/8111554

404

No promo code exists with the supplied Id.

get/Mediapartners/{AccountSID}/PromoCodes/{Id}

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/PromoCodes/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "Id": "8111554",
  "Code": "HAZEL10OFF",
  "State": "ACTIVE",
  "Program": {
    "Id": "21282",
    "Name": "Acme's Creator Program",
    "Uri": "/Mediapartners/<AccountSID>/Campaigns/21282",
    "LogoUri": "/Mediapartners/<AccountSID>/Campaigns/21282/Logo"
  },
  "Advertiser": {
    "Id": "1804207",
    "Name": "Acme Corporation",
    "Uri": "/Mediapartners/<AccountSID>/Advertisers/1804207",
    "LogoUri": "/Mediapartners/<AccountSID>/Advertisers/1804207/Logo"
  },
  "Deal": {
    "Id": "92812",
    "Name": "Summer Promotion",
    "Uri": "/Mediapartners/<AccountSID>/Campaigns/10306/Deals/92812"
  },
  "MatchMode": "LI",
  "CreditRule": "ALWAYS",
  "CreatedDate": "2023-12-12T03:28:40-08:00",
  "StartDate": "2026-01-01T00:00:00-08:00",
  "EndDate": "2026-01-31T23:59:59-08:00",
  "Uri": "/Mediapartners/<AccountSID>/PromoCodes/8111554"
}