Deals

List all deals

get

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Query parameters

CampaignIdintegerOptional

Filter deals by the associated campaign ID.

Scopestring · enumOptional

Filter deals by their scope.

Possible values:

Statestring · enumOptional

Filter deals by their current state.

Possible values:

Typestring · enumOptional

Filter deals by their type.

Possible values:

Responses

200

application/json

get/Advertisers/{AccountSID}/Deals

GET /Advertisers/{AccountSID}/Deals HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

{
  "Deals": [
    {
      "Id": "1",
      "Name": "AcmeDeal3",
      "CampaignId": "10000",
      "State": "ACTIVE",
      "Type": "GENERAL_SALE",
      "Scope": "PRODUCT",
      "Description": "10% off Acme tennis balls",
      "StartDate": "2026-01-01T00:00:00-08:00",
      "EndDate": "2026-12-31T23:59:59-08:00",
      "Categories": "text",
      "BogoBuyQuantity": 1,
      "BogoBuyScope": "text",
      "BogoBuyName": "text",
      "BogoBuyImageUrl": "https://example.com",
      "BogoGetQuantity": 1,
      "BogoGetScope": "text",
      "BogoGetDiscountType": "text",
      "BogoGetName": "text",
      "BogoGetImageUrl": "https://example.com",
      "BogoGetDiscountAmount": 1,
      "BogoGetDiscountCurrency": "text",
      "BogoGetDiscountPercent": 1,
      "PurchaseLimitQuantity": 1,
      "DateCreated": "2026-07-16T10:11:09.163Z",
      "DateLastUpdated": "2026-07-16T10:11:09.163Z",
      "DiscountType": "FIXED",
      "DiscountAmount": "5.00",
      "DiscountMaximumPercent": 1,
      "DiscountPercentRangeStart": 1,
      "DiscountPercentRangeEnd": 1,
      "DiscountCurrency": "USD",
      "MinimumPurchaseAmount": 1,
      "MinimumPurchaseAmountCurrency": "text",
      "MaximumSavingsAmount": 1,
      "MaximumSavingsCurrency": "text",
      "DiscountPercent": "",
      "Gift": "text",
      "RebateAmount": 1,
      "RebateCurrency": "text",
      "DefaultPromoCode": "text",
      "Products": [
        {
          "ProductName": "text",
          "ProductImageURL": "text",
          "ProductBeforePriceAmount": "text",
          "ProductAfterPriceAmount": "text"
        }
      ],
      "Uri": "/Advertisers/<AccountSID>/Deals/1"
    }
  ]
}

Create a deal

post

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Body

CampaignIdstringRequired

The unique identifier of the campaign the deal belongs to.

Example: 10000

NamestringRequired

The display name of the deal.

Example: AcmeDeal3

ScopestringRequired

What the deal applies to.

Example: PRODUCT

TypestringRequired

The type of deal.

Example: GENERAL_SALE

DescriptionstringOptional

A description of the deal that may be shown to partners.

StartDatestringOptional

The date and time the deal becomes active.

EndDatestringOptional

The date and time the deal expires.

DefaultPromoCodestringOptional

The default promo code partners can promote for this deal.

Example: APlusAnvils

DiscountTypestringOptional

How the discount is calculated.

Example: FIXED

DiscountAmountstringOptional

The flat discount amount, when DiscountType is FIXED.

Example: 5.00

DiscountCurrencystringOptional

Three-letter ISO 4217 currency code for the discount amount.

Example: USD

DiscountPercentstringOptional

The discount percentage, when DiscountType is PERCENT.

BogoBuyNamestringOptional

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

BogoBuyQuantitystringOptional

Quantity the customer must buy in a BOGO deal.

Example: 0

BogoGetDiscountTypestringOptional

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

GiftstringOptional

The gift offered, when Type is GIFT_WITH_PURCHASE.

RebateAmountstringOptional

The rebate amount, when Type is REBATE.

RebateCurrencystringOptional

Three-letter ISO 4217 currency code for the rebate amount.

SynchAdsPromoCodesbooleanOptional

Whether to synchronize promo codes with ads.

Example: false

Responses

200

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

UristringOptional

The unique reference to the affected deal.

Example: /Advertisers/<AccountSID>/Deals/1

post/Advertisers/{AccountSID}/Deals

POST /Advertisers/{AccountSID}/Deals HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 393

"CampaignId='10000'&Name='AcmeDeal3'&Scope='PRODUCT'&Type='GENERAL_SALE'&Description=''&StartDate=''&EndDate=''&DefaultPromoCode='APlusAnvils'&DiscountType='FIXED'&DiscountAmount='5.00'&DiscountCurrency='USD'&DiscountPercent=''&BogoBuyName=''&BogoBuyQuantity='0'&BogoGetDiscountType=''&Gift=''&RebateAmount=''&RebateCurrency=''&SynchAdsPromoCodes='false'"

200

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Deals/1"
}

Retrieve a deal

get

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

DealIdintegerRequired

The unique identifier for the deal.

Responses

200

application/json

IdstringOptional

The unique identifier for the deal.

Example: 1

NamestringOptional

The display name of the deal.

Example: AcmeDeal3

CampaignIdstringOptional

The unique identifier of the campaign the deal belongs to.

Example: 10000

Statestring · enumOptional

The current state of the deal.

Example: ACTIVEPossible values:

Typestring · enumOptional

The type of deal — what it offers.

Example: GENERAL_SALEPossible values:

Scopestring · enumOptional

What the deal applies to (a category, the entire store, or a specific product).

Example: PRODUCTPossible values:

DescriptionstringOptional

A description of the deal that may be shown to partners.

Example: 10% off Acme tennis balls

StartDatestring · date-timeOptional

The date and time the deal becomes active.

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

EndDatestring · date-timeOptional

The date and time the deal expires.

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

CategoriesstringOptional

Comma-separated list of categories the deal applies to, when Scope is CATEGORY.

BogoBuyQuantityintegerOptional

Quantity the customer must buy in a BOGO deal.

BogoBuyScopestringOptional

Whether the "buy" requirement is a specific product or category in a BOGO deal.

BogoBuyNamestringOptional

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

BogoBuyImageUrlstring · uriOptional

If Type is BOGO, the "buy" product image URL.

BogoGetQuantityintegerOptional

Quantity the customer receives in a BOGO deal.

BogoGetScopestringOptional

Whether the "get" item is a specific product or category in a BOGO deal.

BogoGetDiscountTypestringOptional

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

BogoGetNamestringOptional

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

BogoGetImageUrlstring · uriOptional

If Type is BOGO, the "get" product image URL.

BogoGetDiscountAmountnumber · decimalOptional

Flat discount amount on the "get" item in a BOGO deal.

BogoGetDiscountCurrencystringOptional

Currency code for the BOGO get discount amount (ISO 4217).

BogoGetDiscountPercentnumber · floatOptional

Discount percentage on the "get" item in a BOGO deal.

PurchaseLimitQuantityintegerOptional

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

DateCreatedstring · date-timeOptional

Date the deal was created.

DateLastUpdatedstring · date-timeOptional

Date the deal was last updated.

DiscountTypestring · enumOptional

How the discount is calculated.

Example: FIXEDPossible values:

DiscountAmountstringOptional

The flat discount amount, when DiscountType is FIXED.

Example: 5.00

DiscountMaximumPercentnumber · floatOptional

Maximum discount percentage, when DiscountType is PERCENT_MAXIMUM.

DiscountPercentRangeStartnumber · floatOptional

Lower bound of the discount range, when DiscountType is PERCENT_RANGE.

DiscountPercentRangeEndnumber · floatOptional

Upper bound of the discount range, when DiscountType is PERCENT_RANGE.

DiscountCurrencystringOptional

Three-letter ISO 4217 currency code for the discount amount.

Example: USD

MinimumPurchaseAmountnumber · decimalOptional

Minimum amount the consumer needs to spend for the deal to apply.

MinimumPurchaseAmountCurrencystringOptional

Currency of the deal's minimum purchase amount (ISO 4217).

MaximumSavingsAmountnumber · decimalOptional

Maximum amount a consumer can save when the deal applies.

MaximumSavingsCurrencystringOptional

Currency of the deal's maximum savings (ISO 4217).

DiscountPercentstringOptional

The discount percentage, when DiscountType is PERCENT.

GiftstringOptional

Gift offered, when Type is GIFT_WITH_PURCHASE.

RebateAmountnumber · decimalOptional

Rebate amount, when Type is REBATE.

RebateCurrencystringOptional

Currency of the rebate amount (ISO 4217).

DefaultPromoCodestringOptional

Default promo code partners can promote for this deal.

Uristring · uri-referenceOptional

The unique reference to this deal in the impact.com API.

Example: /Advertisers/<AccountSID>/Deals/1

get/Advertisers/{AccountSID}/Deals/{DealId}

GET /Advertisers/{AccountSID}/Deals/{DealId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

{
  "Id": "1",
  "Name": "AcmeDeal3",
  "CampaignId": "10000",
  "State": "ACTIVE",
  "Type": "GENERAL_SALE",
  "Scope": "PRODUCT",
  "Description": "10% off Acme tennis balls",
  "StartDate": "2026-01-01T00:00:00-08:00",
  "EndDate": "2026-12-31T23:59:59-08:00",
  "Categories": "text",
  "BogoBuyQuantity": 1,
  "BogoBuyScope": "text",
  "BogoBuyName": "text",
  "BogoBuyImageUrl": "https://example.com",
  "BogoGetQuantity": 1,
  "BogoGetScope": "text",
  "BogoGetDiscountType": "text",
  "BogoGetName": "text",
  "BogoGetImageUrl": "https://example.com",
  "BogoGetDiscountAmount": 1,
  "BogoGetDiscountCurrency": "text",
  "BogoGetDiscountPercent": 1,
  "PurchaseLimitQuantity": 1,
  "DateCreated": "2026-07-16T10:11:09.163Z",
  "DateLastUpdated": "2026-07-16T10:11:09.163Z",
  "DiscountType": "FIXED",
  "DiscountAmount": "5.00",
  "DiscountMaximumPercent": 1,
  "DiscountPercentRangeStart": 1,
  "DiscountPercentRangeEnd": 1,
  "DiscountCurrency": "USD",
  "MinimumPurchaseAmount": 1,
  "MinimumPurchaseAmountCurrency": "text",
  "MaximumSavingsAmount": 1,
  "MaximumSavingsCurrency": "text",
  "DiscountPercent": "",
  "Gift": "text",
  "RebateAmount": 1,
  "RebateCurrency": "text",
  "DefaultPromoCode": "text",
  "Products": [
    {
      "ProductName": "text",
      "ProductImageURL": "text",
      "ProductBeforePriceAmount": "text",
      "ProductAfterPriceAmount": "text"
    }
  ],
  "Uri": "/Advertisers/<AccountSID>/Deals/1"
}

Update a deal

put

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

DealIdintegerRequired

The unique identifier for the deal.

Body

Fields available for updating an existing deal. All fields are optional; only provided fields are updated.

Note: The following fields appear on the deal object but cannot be updated via API — they are managed in the impact.com platform: Seasonal, DealType, DefaultPromoCode, MinimumPurchaseAmount, MaximumSavingsAmount, LimitedTimeDeal, RestrictedMediaPartners, RestrictedMediaPartnerGroups.

DescriptionstringOptional

A description of the deal that may be shown to partners.

Example: Updated description.

StartDatestringOptional

The date and time the deal becomes active.

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

EndDatestringOptional

The date and time the deal expires.

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

NamestringOptional

The display name of the deal.

Example: AcmeDeal3

SynchAdsPromoCodesbooleanOptional

Whether to synchronize promo codes with ads.

Example: false

DealScopestringOptional

To what extent the deal applies to the store. Enum values: PRODUCT, CATEGORY, ENTIRE_STORE.

DiscountTypestringOptional

What kind of discount a consumer receives. Use only if DealType=GENERAL_SALE. Enum values: FIXED, PERCENT, PERCENT_RANGE, PERCENT_MAXIMUM.

DiscountAmountnumber · decimalOptional

Deal's discount amount. Required when DiscountType=FIXED.

DiscountPercentnumber · floatOptional

Deal's discount percent. Required when DiscountType=PERCENT.

DiscountPercentRangeStartnumber · floatOptional

Beginning of the discount range. Required when DiscountType=PERCENT_RANGE.

DiscountPercentRangeEndnumber · floatOptional

End of the discount range. Required when DiscountType=PERCENT_RANGE.

DiscountMaximumPercentnumber · floatOptional

Maximum discount percent. Required when DiscountType=PERCENT_MAXIMUM.

GiftstringOptional

Name of the gift that comes with a purchase. Required when DealType=GIFT_WITH_PURCHASE.

RebateAmountnumber · decimalOptional

Purchase rebate amount. Required when DealType=REBATE.

BogoBuyNamestringOptional

Name of the "buy" product. Required when DealType=BOGO.

BogoBuyQuantityintegerOptional

"Buy" product quantity available. Required when DealType=BOGO.

BogoBuyScopestringOptional

"Buy" product scope. Required when DealType=BOGO. Enum values: PRODUCT, CATEGORY.

BogoBuyImageFileNamestringOptional

URL to the "buy" product's image. Used when DealType=BOGO.

BogoGetNamestringOptional

"Get" product name. Required when DealType=BOGO.

BogoGetQuantityintegerOptional

"Get" product quantity available. Required when DealType=BOGO.

BogoGetScopestringOptional

"Get" product scope. Required when DealType=BOGO. Enum values: PRODUCT, CATEGORY.

BogoGetDiscountTypestringOptional

"Get" product discount type. Required when DealType=BOGO. Enum values: FREE, AMOUNT, PERCENT.

BogoGetDiscountAmountnumber · decimalOptional

"Get" product discount amount. Required when DealType=BOGO and BogoGetDiscountType=AMOUNT.

BogoGetDiscountPercentnumber · floatOptional

"Get" product discount percentage. Required when DealType=BOGO and BogoGetDiscountType=PERCENT.

BogoGetImageFileNamestringOptional

URL to the "get" product's image. Used when DealType=BOGO.

ProductNamestringOptional

Product's name. Required when DealScope=PRODUCT.

ProductFileNamestringOptional

Product's image file name. Used when DealScope=PRODUCT.

RegularPricenumber · decimalOptional

Product's original price. Used when DealScope=PRODUCT.

DealPricenumber · decimalOptional

Product's deal price. Used when DealScope=PRODUCT.

PurchaseLimitQuantityintegerOptional

Maximum quantity of "buy" product purchasable in one transaction. Enter 0 for no limit. Used when DealScope=PRODUCT.

CategoriesstringOptional

Comma-separated list of deal categories. Used when DealScope=CATEGORY.

Responses

200

application/json

StatusstringOptional

Indicates whether the operation was successful.

Example: OK

UristringOptional

The unique reference to the affected deal.

Example: /Advertisers/<AccountSID>/Deals/1

put/Advertisers/{AccountSID}/Deals/{DealId}

PUT /Advertisers/{AccountSID}/Deals/{DealId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 749

"Description='Updated description.'&StartDate='2026-01-01T00:00:00-08:00'&EndDate='2026-12-31T23:59:59-08:00'&Name='AcmeDeal3'&SynchAdsPromoCodes=false&DealScope='text'&DiscountType='text'&DiscountAmount=1&DiscountPercent=1&DiscountPercentRangeStart=1&DiscountPercentRangeEnd=1&DiscountMaximumPercent=1&Gift='text'&RebateAmount=1&BogoBuyName='text'&BogoBuyQuantity=1&BogoBuyScope='text'&BogoBuyImageFileName='text'&BogoGetName='text'&BogoGetQuantity=1&BogoGetScope='text'&BogoGetDiscountType='text'&BogoGetDiscountAmount=1&BogoGetDiscountPercent=1&BogoGetImageFileName='text'&ProductName='text'&ProductFileName='text'&RegularPrice=1&DealPrice=1&PurchaseLimitQuantity=1&Categories='text'"

200

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Deals/1"
}

Delete a deal

delete

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

DealIdintegerRequired

The unique identifier for the deal.

Responses

200

application/json

StatusstringOptional

Indicates that the deal was deleted.

Example: DELETED

delete/Advertisers/{AccountSID}/Deals/{DealId}

DELETE /Advertisers/{AccountSID}/Deals/{DealId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

{
  "Status": "DELETED"
}

PreviousDeals NextModels

Last updated 1 month ago