Promo Codes

List All Promo Codes

get

Returns a list of your promo codes, which can be filtered.

Path parameters

AccountSIDstringRequired

Query parameters

CampaignIdintegerOptional

CodestringOptional

StartDatestring · date-timeOptional

EndDatestring · date-timeOptional

Statestring · enumOptionalPossible values:

Responses

200

A paginated list of promo code objects.

application/json

get

/Advertisers/{AccountSID}/PromoCodes

GET /Advertisers/{AccountSID}/PromoCodes HTTP/1.1
Host: api.impact.com
Accept: */*

200

A paginated list of promo code objects.

{
  "PromoCodes": [
    {
      "Id": 12345,
      "Code": "SUMMER25",
      "Type": "LI",
      "CreditPolicy": "ALWAYS",
      "CampaignId": 1000,
      "CampaignName": "Acme Campaign",
      "AssignedPartnerId": 2552842,
      "AssignedPartnerName": "Wile E. Coyote Facebook",
      "CreatedDate": "2026-01-15T10:00:00-08:00",
      "StartDate": "2026-06-01T00:00:00-07:00",
      "EndDate": "2026-08-31T23:59:59-07:00",
      "State": "ACTIVE",
      "DealId": 3,
      "DealName": "AcmeDeal3",
      "DealState": "ACTIVE",
      "DealType": "GENERAL_SALE",
      "DealScope": "PRODUCT",
      "DealStartDate": "2026-06-01T00:00:00-07:00",
      "DealEndDate": "2026-08-31T23:59:59-07:00",
      "DiscountType": "FIXED",
      "DiscountAmount": 5,
      "DiscountCurrency": "USD",
      "DiscountPercent": 10,
      "MinimumPurchaseAmount": 50,
      "MaximumSavingsAmount": 20,
      "PurchaseLimitQuantity": 1,
      "BogoBuyQuantity": 0,
      "BogoBuyName": "",
      "BogoGetQuantity": 1,
      "BogoGetName": "text",
      "BogoGetDiscountType": "text",
      "SynchAdsPromoCodes": true,
      "Uri": "/Advertisers/<AccountSID>/PromoCodes/7777777"
    }
  ]
}

Create a Promo Code

post

Creates a new promo code and assigns it to a partner.

Path parameters

AccountSIDstringRequired

Body

AssignedPartnerIdintegerRequired

The partner account ID this promo code is assigned to.

CampaignIdintegerRequired

The program ID this promo code applies to.

CreditPolicystring · enumRequired

How credit is awarded for actions involving this code.

Possible values:

CodestringRequired

The promo code value.

Typestring · enumRequired

LI for Exact match, RE for Regex.

Possible values:

StartDatestring · date-timeOptional

The date and time the promo code becomes active.

EndDatestring · date-timeOptional

The date and time the promo code expires.

DealIdintegerOptional

The unique identifier of a Deal to link this promo code to.

DealNamestringOptional

The display name of the linked Deal.

Responses

200

The request was successful.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected promo code.

post

/Advertisers/{AccountSID}/PromoCodes

POST /Advertisers/{AccountSID}/PromoCodes HTTP/1.1
Host: api.impact.com
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 193

"AssignedPartnerId=1&CampaignId=1&CreditPolicy='ALWAYS'&Code='text'&Type='LI'&StartDate='2026-06-10T11:30:49.107Z'&EndDate='2026-06-10T11:30:49.107Z'&DealId=1&DealName='text'"

200

The request was successful.

{
  "Status": "OK",
  "Uri": "../folder"
}

Get Promo Code Details

get

Retrieves the details of a single promo code by its unique ID.

Path parameters

AccountSIDstringRequired

PromoCodeIdintegerRequired

The unique identifier for the promo code.

Responses

200

A single promo code object.

application/json

IdintegerOptional

The unique identifier for the promo code.

Example: 12345

CodestringOptional

The promo code value.

Example: SUMMER25

Typestring · enumOptional

LI for Exact match, RE for Regex.

Possible values:

CreditPolicystring · enumOptional

How credit is awarded for actions involving this code.

Possible values:

CampaignIdintegerOptional

The unique identifier of the program this promo code applies to.

Example: 1000

CampaignNamestringOptional

The display name of the program.

Example: Acme Campaign

AssignedPartnerIdintegerOptional

The unique identifier of the partner this promo code is assigned to.

Example: 2552842

AssignedPartnerNamestringOptional

The display name of the assigned partner.

Example: Wile E. Coyote Facebook

CreatedDatestring · date-timeOptional

The date and time the promo code was created.

Example: 2026-01-15T10:00:00-08:00

StartDatestring · date-time · nullableOptional

The date and time the promo code becomes active.

Example: 2026-06-01T00:00:00-07:00

EndDatestring · date-time · nullableOptional

The date and time the promo code expires.

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

Statestring · enumOptional

The current state of the promo code.

Possible values:

DealIdinteger · nullableOptional

The unique identifier of the Deal this promo code is linked to, if any.

Example: 3

DealNamestring · nullableOptional

The display name of the linked Deal.

Example: AcmeDeal3

DealStatestring · nullableOptional

The state of the linked Deal.

Example: ACTIVE

DealTypestring · nullableOptional

The type of the linked Deal.

Example: GENERAL_SALE

DealScopestring · nullableOptional

The scope of the linked Deal.

Example: PRODUCT

DealStartDatestring · date-time · nullableOptional

The start date of the linked Deal.

Example: 2026-06-01T00:00:00-07:00

DealEndDatestring · date-time · nullableOptional

The end date of the linked Deal.

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

DiscountTypestring · nullableOptional

How the discount is calculated.

Example: FIXED

DiscountAmountnumber · decimal · nullableOptional

The flat discount amount, when DiscountType is FIXED.

Example: 5

DiscountCurrencystring · nullableOptional

Three-letter ISO 4217 currency code for the discount.

Example: USD

DiscountPercentnumber · float · nullableOptional

The discount percentage, when DiscountType is PERCENT.

Example: 10

MinimumPurchaseAmountnumber · decimal · nullableOptional

The minimum order amount required for the deal to apply.

Example: 50

MaximumSavingsAmountnumber · decimal · nullableOptional

The maximum total savings the deal can apply to a single order.

Example: 20

PurchaseLimitQuantityintegerOptional

Maximum number of times the deal can be applied per order.

Example: 1

BogoBuyQuantityintegerOptional

Quantity the customer must buy in a BOGO deal.

Example: 0

BogoBuyNamestring · nullableOptional

Name of the item the customer must buy in a BOGO deal.

BogoGetQuantityintegerOptional

Quantity the customer receives in a BOGO deal.

BogoGetNamestring · nullableOptional

Name of the item the customer receives in a BOGO deal.

BogoGetDiscountTypestring · nullableOptional

How the discount on the "get" item is calculated in a BOGO deal.

SynchAdsPromoCodesbooleanOptional

Whether to synchronize promo codes with ads.

Uristring · uri-referenceOptional

The unique reference to this promo code in the impact.com API.

Example: /Advertisers/<AccountSID>/PromoCodes/7777777

get

/Advertisers/{AccountSID}/PromoCodes/{PromoCodeId}

GET /Advertisers/{AccountSID}/PromoCodes/{PromoCodeId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

A single promo code object.

{
  "Id": 12345,
  "Code": "SUMMER25",
  "Type": "LI",
  "CreditPolicy": "ALWAYS",
  "CampaignId": 1000,
  "CampaignName": "Acme Campaign",
  "AssignedPartnerId": 2552842,
  "AssignedPartnerName": "Wile E. Coyote Facebook",
  "CreatedDate": "2026-01-15T10:00:00-08:00",
  "StartDate": "2026-06-01T00:00:00-07:00",
  "EndDate": "2026-08-31T23:59:59-07:00",
  "State": "ACTIVE",
  "DealId": 3,
  "DealName": "AcmeDeal3",
  "DealState": "ACTIVE",
  "DealType": "GENERAL_SALE",
  "DealScope": "PRODUCT",
  "DealStartDate": "2026-06-01T00:00:00-07:00",
  "DealEndDate": "2026-08-31T23:59:59-07:00",
  "DiscountType": "FIXED",
  "DiscountAmount": 5,
  "DiscountCurrency": "USD",
  "DiscountPercent": 10,
  "MinimumPurchaseAmount": 50,
  "MaximumSavingsAmount": 20,
  "PurchaseLimitQuantity": 1,
  "BogoBuyQuantity": 0,
  "BogoBuyName": "",
  "BogoGetQuantity": 1,
  "BogoGetName": "text",
  "BogoGetDiscountType": "text",
  "SynchAdsPromoCodes": true,
  "Uri": "/Advertisers/<AccountSID>/PromoCodes/7777777"
}

Expire a Promo Code

delete

Expires a promo code, which deactivates it. The code is not permanently deleted.

Path parameters

AccountSIDstringRequired

PromoCodeIdintegerRequired

The unique identifier for the promo code to expire.

Responses

200

The request was successful.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the affected promo code.

delete

/Advertisers/{AccountSID}/PromoCodes/{PromoCodeId}

DELETE /Advertisers/{AccountSID}/PromoCodes/{PromoCodeId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

The request was successful.

{
  "Status": "OK",
  "Uri": "../folder"
}

PreviousPromo Codes NextModels

Last updated 5 days ago