API Reference

Update a deal

Updates the specified deal by setting the values of the parameters passed. Any parameters not provided will be left unchanged. More parameters can be changed via UI.

Parameters

Description optional

Description of the deal.

StartDate optional

Date and time the deal begins. See ISO 8601.

EndDate optional

Date and time the deal ends. See ISO 8601.

Name optional

Name of the deal.

SynchAdsPromoCodes optional

If the deal aligns all associated ad and promo code states and date ranges to the deal's.

Parameters changeable via UI

View UI parameters

Seasonal optional

Associate a deal with a specific time of year. Cannot update via API.

DealType optional

What the deal does. Cannot update via API.

View possible enum values
BOGODeal will apply a buy-one-get-one deal to the order. The following parameters are required: BogoBuyQuantity,
BogoBuyName,
BogoBuyScope,
BogoGetQuantity,
BogoGetName,
BogoGetScope,
BogoGetDiscountType.
GENERAL_SALEDeal applies a general discount to the products identified in DealScope. One of the following parameter sets is required:
DiscountPercent,
DiscountAmount together with DiscountCurrency,
DiscountMaximumPercent, or
DiscountPercentRangeStart together with DiscountPercentRangeEnd.
FREE_SHIPPINGDeal applies free shipping to the order.
GIFT_WITH_PURCHASEA gift will come with the order. `Gift` parameter is required.
REBATEA rebate will be available to the customer upon purchase. RebateAmount and RebateCurrency are required.

BOGO parameters

View BOGO parameters

BogoBuyName optional

Name of the "buy" product. Cannot use if Type≠"BOGO".

BogoBuyQuantity optional

"Buy" product quantity available. Cannot use if Type≠"BOGO".

BogoBuyScope optional

"Buy" product scope. Cannot use if Type≠"BOGO".

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.

BogoBuyImageFileName optional

URL to the "buy" product's image. Cannot use if Type≠"BOGO".

BogoGetDiscountAmount optional

"Get" product discount amount. Cannot use if Type≠"BOGO" and BogoGetDiscountType≠"AMOUNT".

BogoGetDiscountType optional

"Get" product discount type. Cannot use if Type≠"BOGO".

View possible enum values
FREECustomer will receive the "Get" item for free.
AMOUNTCustomer will receive a specific amount of money off of the `GET` item's cost. BogoGetDiscountAmount is required.
PERCENTCustomer will receive a percent off of the `GET` item's cost. BogoGetDiscountPercent is required.

BogoGetDiscountPercent optional

"Get" product discount percentage. Cannot use if Type≠"BOGO" and BogoGetDiscountType≠"PERCENT".

BogoGetName optional

"Get" product name. Cannot use if Type≠"BOGO".

BogoGetQuantity optional

"Get" product quantity available. Cannot use if Type≠"BOGO".

BogoGetScope optional

"Get" product scope. Cannot use if Type≠"BOGO".

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.

BogoGetImageFileName optional

URL to the "get" product's image. Cannot use if Type≠"BOGO".

General Sale parameters

View General Sale parameters

DealScope optional

To what extent the deal applies to the store.

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.
ENTIRE_STOREDeal applies to the entire store.

DiscountType optional

What kind of discount a consumer will get. Use only if Type="GENERAL_SALE".

View possible enum values
FIXEDDeal gives a fixed amount off.
PERCENTDeal gives a percentage off.
PERCENT_RANGEDeal gives a percentage range off.
PERCENT_MAXIMUMDeal gives up to a certain percentage off.

DiscountAmount optional

Deal's discount amount. Cannot use if DiscountType≠"FIXED".

ProductName optional

Product's name. Cannot use if DiscountScope≠"Product".

ProductFileName optional

Product's image file name. Cannot use if DiscountScope≠"Product".

RegularPrice optional

Product's original price. Cannot use if DiscountScope≠"Product".

DealPrice optional

Product's deal price. Cannot use if DiscountScope≠"Product".

PurchaseLimitQuantity optional

Maximum quantity of "buy" product purchasable in one transaction. Enter 0 to have no purchase limit. Cannot use if DiscountScope≠"Product".

Categories optional

Deal category information. Cannot use if Scope≠"CATEGORY".

DiscountPercent optional

Deal's discount percent. Cannot use if DiscountType≠"PERCENT".

DiscountPercentRangeStart optional

Beginning of the discount range. Cannot use if DiscountType≠"PERCENT_RANGE".

DiscountPercentRangeEnd optional

End of the discount range. Cannot use if DiscountType≠"PERCENT_RANGE".

DiscountMaximumPercent optional

Maximum discount percent. Cannot use if DiscountType≠"PERCENT_MAXIMUM".

Gift parameters

View Gift parameters

Gift optional

Name of the gift that comes with a purchase. Cannot use if Type≠"GIFT_WITH_PURCHASE".

DealScope optional

To what extent the deal applies to the store.

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.
ENTIRE_STOREDeal applies to the entire store.

ProductName optional

Product's name. Cannot use if DiscountScope≠"Product".

ProductFileName optional

Product's image file name. Cannot use if DiscountScope≠"Product".

RegularPrice optional

Product's original price. Cannot use if DiscountScope≠"Product".

DealPrice optional

Product's deal price. Cannot use if DiscountScope≠"Product".

PurchaseLimitQuantity optional

Maximum quantity of "buy" product purchasable in one transaction. Enter 0 to have no purchase limit. Cannot use if DiscountScope≠"Product".

Categories optional

Deal category information. Cannot use if Scope≠"CATEGORY".

Rebate parameters

View Rebate parameters

RebateAmount optional

Purchase rebate amount. Cannot use if Type≠"REBATE".

DealScope optional

To what extent the deal applies to the store.

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.
ENTIRE_STOREDeal applies to the entire store.

ProductName optional

Product's name. Cannot use if DiscountScope≠"Product".

ProductFileName optional

Product's image file name. Cannot use if DiscountScope≠"Product".

RegularPrice optional

Product's original price. Cannot use if DiscountScope≠"Product".

DealPrice optional

Product's deal price. Cannot use if DiscountScope≠"Product".

PurchaseLimitQuantity optional

Maximum quantity of "buy" product purchasable in one transaction. Enter 0 to have no purchase limit. Cannot use if DiscountScope≠"Product".

Categories optional

Deal category information. Cannot use if Scope≠"CATEGORY".

DefaultPromoCode optional

Deal's default promo code. Cannot update via API.

MinimumPurchaseAmount optional

Deal's minimum purchase amount. Cannot update via API.

MaximumSavingsAmount optional

Deal's maximum purchase savings. Cannot update via API.

LimitedTimeDeal optional

Set a time range that the deal will be active. Cannot update via API.

RestrictedMediaPartners array

Array of partner names that can use the deal. Cannot update

RestrictedMediaPartnerGroups array

Array of partner groups that can use the deal.

Returns

Returns the status of the request and the URI of the newly updated deal. Returns an error if update parameters are invalid.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Deals/00003' \
  -X PUT \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'Description="This is a description"' \
  -d 'EndDate=2021-12-15T10:10:07-08:00' \
  -d 'Name=ACME Deal 17' \
  -d 'StartDate=2021-12-11T10:10:07-08:00' \
  -d 'SynchAdsPromoCodes=false'

Example Response

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