Promotions

Endpoints for listing and retrieving brand promotions available to your partner account.

List promotions

get

Returns a list of all brand promotions currently available to your account.

Authorizations

basicAuth

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Responses

200

OK

application/json

get/Mediapartners/{AccountSID}/Promotions

curl

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

200

OK

{
  "Promotions": [
    {
      "AdvertiserId": "12345",
      "AdvertiserName": "Hazel's Wellness Co",
      "AdvertiserLocation": "United States",
      "PromotionFileId": "37",
      "PromotionIds": "123456789",
      "PromotionTitle": "20% Off Wellness Essentials — New Year Sale",
      "NumberOfProducts": 24,
      "PromotionEffectiveDates": "2026-01-01/2026-01-31",
      "GenericRedemptionCode": "WELLNESS20",
      "PromotionItemsUri": "/Mediapartners/<AccountSID>/Catalogs/ItemSearch?Query=PromotionIds='123456789'",
      "Uri": "/Mediapartners/<AccountSID>/Promotions/123456789"
    }
  ]
}

Retrieve a promotion

get

Retrieves the details of a single promotion. Pass the value of PromotionIds (from a List Promotions response) as the path 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 of the promotion (matches PromotionIds from a List Promotions response).

Responses

200

OK

application/json

AdvertiserIdstringOptional

Unique identifier of the brand offering the promotion.

Example: 12345

AdvertiserNamestringOptional

Name of the brand offering the promotion.

Example: Hazel's Wellness Co

AdvertiserLocationstringOptional

Country in which the brand offering the promotion is based.

Example: United States

PromotionFileIdstringOptional

Unique identifier of the promotion file (the upload batch this promotion was loaded from). Use this for traceability when a brand bulk-uploads promotions.

Example: 37

PromotionIdsstringOptional

Unique identifier for this promotion. Despite the plural name, this is a single ID for one promotion — use it as the path Id when calling Retrieve a promotion.

Example: 123456789

PromotionTitlestringOptional

The marketing headline for the promotion, suitable for displaying to your audience.

Example: 20% Off Wellness Essentials — New Year Sale

NumberOfProductsintegerOptional

The number of products covered by this promotion.

Example: 24

PromotionEffectiveDatesstringOptional

The date range during which the promotion is active, in ISO 8601 interval format: <start>/<end>.

Example: 2026-01-01/2026-01-31

GenericRedemptionCodestringOptional

The promo code your audience can apply at checkout to redeem this promotion. Empty when the promotion is automatically applied or has no associated code.

Example: WELLNESS20

PromotionItemsUristringOptional

API resource path that returns the items covered by this promotion. This is a pre-filtered search against the Catalogs API.

Example: /Mediapartners/<AccountSID>/Catalogs/ItemSearch?Query=PromotionIds='123456789'

UristringOptional

Unique reference to this promotion in the impact.com API.

Example: /Mediapartners/<AccountSID>/Promotions/123456789

404

No promotion exists with the supplied Id.

get/Mediapartners/{AccountSID}/Promotions/{Id}

curl

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

{
  "AdvertiserId": "12345",
  "AdvertiserName": "Hazel's Wellness Co",
  "AdvertiserLocation": "United States",
  "PromotionFileId": "37",
  "PromotionIds": "123456789",
  "PromotionTitle": "20% Off Wellness Essentials — New Year Sale",
  "NumberOfProducts": 24,
  "PromotionEffectiveDates": "2026-01-01/2026-01-31",
  "GenericRedemptionCode": "WELLNESS20",
  "PromotionItemsUri": "/Mediapartners/<AccountSID>/Catalogs/ItemSearch?Query=PromotionIds='123456789'",
  "Uri": "/Mediapartners/<AccountSID>/Promotions/123456789"
}