Ads | Brand API Reference v11

List all ads

get

Returns an array of ad objects, ordered by creation date (newest first).

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Query parameters

CampaignIdstringOptional

Filter ads by a specific campaign (program) ID.

Typestring · enumOptional

Filter ads by their type.

Possible values:

DealIdstringOptional

Filter ads associated with a specific deal ID.

MobileReadybooleanOptional

Filter ads based on whether they are optimized for mobile.

Responses

200

A list of ads.

application/json

@pagestringOptional

get/Advertisers/{AccountSID}/Ads

cURL

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

200

A list of ads.

{
  "@page": "text",
  "Ads": [
    {
      "Id": "892081",
      "Name": "Summer Sale 2020 250x250",
      "Description": "Our best deals this summer creative.",
      "CampaignId": "1000",
      "CampaignName": "Acme Campaign",
      "AdType": "BANNER",
      "LandingPage": "http://www.test.com/6234652",
      "MobileFallbacks": {
        "ANDROID": "text",
        "IOS": "text"
      },
      "CustomAdServingUrl": "",
      "IabAdUnit": "CUSTOM",
      "ThirdPartyServableAdCreativeHeight": "250",
      "ThirdPartyServableAdCreativeWidth": "250",
      "BannerAlternativeTag": "summersale",
      "LinkText": "",
      "CouponLinkName": "text",
      "GetHtmlCodeType": "HTML_AND_IFRAME",
      "Labels": "sale,US",
      "AllowDeepLinking": "true",
      "Language": "ENGLISH",
      "LimitedTimeStartDate": "2020-09-16T17:01:28-07:00",
      "LimitedTimeEndDate": "",
      "Season": "SUMMER",
      "DealId": "85433",
      "DealName": "Summer Sale 2020",
      "DateCreated": "2026-07-13T15:31:34.657Z",
      "DateLastUpdated": "2026-07-13T15:31:34.657Z",
      "AdCodeTemplate": "text",
      "CouponAllowCustomPromoCode": "text",
      "CustomisationCharge": "text",
      "MobileReady": "text",
      "PhoneTracking": "text",
      "PromoCodeTracking": "text",
      "TopSeller": "text",
      "RestrictedMediaPartners": [
        "text"
      ],
      "RestrictedMediaPartnerGroups": [
        "text"
      ],
      "DealDescription": "text",
      "DealState": "text",
      "DealType": "text",
      "DealScope": "text",
      "DealProducts": [
        "text"
      ],
      "DealCategories": "text",
      "DiscountType": "text",
      "DiscountAmount": "text",
      "DiscountCurrency": "text",
      "DiscountPercent": "text",
      "DiscountMaximumPercent": "text",
      "DiscountPercentRangeStart": "text",
      "DiscountPercentRangeEnd": "text",
      "Gift": "text",
      "RebateAmount": "text",
      "RebateCurrency": "text",
      "DealDefaultPromoCode": "text",
      "MinimumPurchaseAmount": "text",
      "MinimumPurchaseAmountCurrency": "text",
      "MaximumSavingsAmount": "text",
      "MaximumSavingsCurrency": "text",
      "BogoBuyQuantity": "text",
      "BogoBuyScope": "text",
      "BogoBuyName": "text",
      "BogoBuyImageUrl": "text",
      "BogoGetQuantity": "text",
      "BogoGetScope": "text",
      "BogoGetDiscountType": "text",
      "BogoGetName": "text",
      "BogoGetImageUrl": "text",
      "BogoGetDiscountAmount": "text",
      "BogoGetDiscountCurrency": "text",
      "BogoGetDiscountPercent": "text",
      "PurchaseLimitQuantity": "text",
      "DealStartDate": "2026-07-13T15:31:34.657Z",
      "DealEndDate": "2026-07-13T15:31:34.657Z",
      "SynchAdsPromoCodes": "text",
      "DealRestrictedMediaPartners": [
        "text"
      ],
      "DealRestrictedMediaPartnerGroups": [
        "text"
      ],
      "Uri": "/Advertisers/{AccountSID}/Ads/892081"
    }
  ]
}

Create an ad

post

Creates a new ad. Note that for impact.com hosted creative assets, multipart/form-data is required. Only Banner, Coupon, and Text Link ads can be created via API.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Body

NamestringRequiredExample: Summer Sale 2020 250x250

CampaignIdstringRequiredExample: 1000

AdTypestring · enumRequiredExample: BANNERPossible values:

CustomAdServingUrlstringOptional

AdCodeTemplatestringOptional

CouponLinkNamestringOptional

CouponAllowCustomPromoCodebooleanOptional

Whether the ad allows partners to use a custom promo code (instead of the default coupon code).

Example: false

CustomisationChargenumber · decimalOptional

The charge applied when partners customise this ad.

Example: 0

LinkTextstringOptional

LanguagestringRequired

The language of the ad creative. Possible values: AFRIKAANS, ARABIC, BULGARIAN, CHINESE, CHINESE_TRADITIONAL, CZECH, DANISH, DUTCH, ENGLISH, ENGLISH_GB, ENGLISH_AU, ENGLISH_CA, ENGLISH_NZ, ENGLISH_ZA, ESTONIAN, FILIPINO, FINNISH, FRENCH, FRENCH_CA, GERMAN, HEBREW, HINDI, INDONESIAN, ITALIAN, JAPANESE, KOREAN, LATVIAN, LITHUANIAN, MALAY, MALTESE, NORWEGIAN, PORTUGUESE, PORTUGUESE_BR, POLISH, RUSSIAN, SLOVENIAN, SPANISH, SPANISH_MX, SWEDISH, THAI, TURKISH, VIETNAMESE.

Example: ENGLISH

DescriptionstringOptionalExample: Our best deals this summer creative.

LandingPagestringOptionalExample: http://www.test.com/6234652

MobileFallbacks.ANDROIDstringOptional

MobileFallbacks.IOSstringOptional

IabAdUnitstringOptionalExample: CUSTOM

ThirdPartyServableAdCreativeHeightstringOptionalExample: 250

ThirdPartyServableAdCreativeWidthstringOptionalExample: 250

BannerAlternativeTagstringOptionalExample: summersale

GetHtmlCodeTypestring · enumOptionalExample: HTML_AND_IFRAMEPossible values:

LabelsstringOptionalExample: sale,US

AllowDeepLinkingstringOptionalExample: true

LimitedTimeStartDatestring · date-timeOptionalExample: 2026-09-16T17:01:28-07:00

LimitedTimeEndDatestring · date-timeOptionalExample: 2026-12-31T23:59:59-07:00

SeasonstringOptional

If the ad has a seasonal promotional theme, this is the season the ad targets. Possible values: ANZAC_DAY, AUGUST_CIVIC_HOLIDAY, AUSTRALIA_DAY, BACK_TO_SCHOOL, BLACK_FRIDAY, BOXING_DAY, CANADA_DAY, CYBER_MONDAY, END_OF_FINANCIAL_YEAR, FAMILY_DAY, FATHERS_DAY, GOOD_FRIDAY, HALLOWEEN, HANUKKAH, INDEPENDANCE_DAY, LABOR_DAY, MEMORIAL_DAY, MOTHERS_DAY, NEW_YEAR, PRESIDENTS_DAY, QUEENS_BIRTHDAY, REMEMBRANCE_DAY, SPRING, ST_PATRICKS_DAY, SUMMER, THANKSGIVING, VALENTINES_DAY, VICTORIA_DAY, WAITANGI_DAY, WINTER, OTHER.

Example: SUMMER

Responses

200

Success response.

application/json

StatusstringOptional

Uristring · uri-referenceOptional

post/Advertisers/{AccountSID}/Ads

cURL

curl -L \
  --request POST \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Ads' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'

200

Success response.

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

Retrieve an ad

get

Retrieves the details of an existing ad using its unique impact.com Ad Id.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

IdstringRequired

Responses

200

Returns an ad object.

application/json

IdstringOptionalExample: 892081

NamestringOptionalExample: Summer Sale 2020 250x250

DescriptionstringOptionalExample: Our best deals this summer creative.

CampaignIdstringOptionalExample: 1000

CampaignNamestringOptionalExample: Acme Campaign

AdTypestring · enumOptionalExample: BANNERPossible values:

LandingPagestringOptionalExample: http://www.test.com/6234652

CustomAdServingUrlstringOptional

IabAdUnitstringOptionalExample: CUSTOM

ThirdPartyServableAdCreativeHeightstringOptionalExample: 250

ThirdPartyServableAdCreativeWidthstringOptionalExample: 250

BannerAlternativeTagstringOptionalExample: summersale

LinkTextstringOptional

CouponLinkNamestringOptional

GetHtmlCodeTypestringOptionalExample: HTML_AND_IFRAME

LabelsstringOptionalExample: sale,US

AllowDeepLinkingstringOptionalExample: true

LanguagestringOptional

Example: ENGLISH

LimitedTimeStartDatestring · date-timeOptionalExample: 2020-09-16T17:01:28-07:00

LimitedTimeEndDatestring · date-timeOptional

SeasonstringOptional

Example: SUMMER

DealIdstringOptionalExample: 85433

DealNamestringOptionalExample: Summer Sale 2020

DateCreatedstring · date-timeOptional

DateLastUpdatedstring · date-timeOptional

AdCodeTemplatestringOptional

CouponAllowCustomPromoCodestringOptional

CustomisationChargestringOptional

MobileReadystringOptional

PhoneTrackingstringOptional

PromoCodeTrackingstringOptional

TopSellerstringOptional

RestrictedMediaPartnersstring[]Optional

RestrictedMediaPartnerGroupsstring[]Optional

DealDescriptionstringOptional

DealStatestringOptional

DealTypestringOptional

DealScopestringOptional

DealProductsstring[]Optional

DealCategoriesstringOptional

DiscountTypestringOptional

DiscountAmountstringOptional

DiscountCurrencystringOptional

DiscountPercentstringOptional

DiscountMaximumPercentstringOptional

DiscountPercentRangeStartstringOptional

DiscountPercentRangeEndstringOptional

GiftstringOptional

RebateAmountstringOptional

RebateCurrencystringOptional

DealDefaultPromoCodestringOptional

MinimumPurchaseAmountstringOptional

MinimumPurchaseAmountCurrencystringOptional

MaximumSavingsAmountstringOptional

MaximumSavingsCurrencystringOptional

BogoBuyQuantitystringOptional

BogoBuyScopestringOptional

BogoBuyNamestringOptional

BogoBuyImageUrlstringOptional

BogoGetQuantitystringOptional

BogoGetScopestringOptional

BogoGetDiscountTypestringOptional

BogoGetNamestringOptional

BogoGetImageUrlstringOptional

BogoGetDiscountAmountstringOptional

BogoGetDiscountCurrencystringOptional

BogoGetDiscountPercentstringOptional

PurchaseLimitQuantitystringOptional

DealStartDatestring · date-timeOptional

DealEndDatestring · date-timeOptional

SynchAdsPromoCodesstringOptional

DealRestrictedMediaPartnersstring[]Optional

DealRestrictedMediaPartnerGroupsstring[]Optional

Uristring · uri-referenceOptionalExample: /Advertisers/{AccountSID}/Ads/892081

get/Advertisers/{AccountSID}/Ads/{Id}

cURL

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

200

Returns an ad object.

{
  "Id": "892081",
  "Name": "Summer Sale 2020 250x250",
  "Description": "Our best deals this summer creative.",
  "CampaignId": "1000",
  "CampaignName": "Acme Campaign",
  "AdType": "BANNER",
  "LandingPage": "http://www.test.com/6234652",
  "MobileFallbacks": {
    "ANDROID": "text",
    "IOS": "text"
  },
  "CustomAdServingUrl": "",
  "IabAdUnit": "CUSTOM",
  "ThirdPartyServableAdCreativeHeight": "250",
  "ThirdPartyServableAdCreativeWidth": "250",
  "BannerAlternativeTag": "summersale",
  "LinkText": "",
  "CouponLinkName": "text",
  "GetHtmlCodeType": "HTML_AND_IFRAME",
  "Labels": "sale,US",
  "AllowDeepLinking": "true",
  "Language": "ENGLISH",
  "LimitedTimeStartDate": "2020-09-16T17:01:28-07:00",
  "LimitedTimeEndDate": "",
  "Season": "SUMMER",
  "DealId": "85433",
  "DealName": "Summer Sale 2020",
  "DateCreated": "2026-07-13T15:31:34.657Z",
  "DateLastUpdated": "2026-07-13T15:31:34.657Z",
  "AdCodeTemplate": "text",
  "CouponAllowCustomPromoCode": "text",
  "CustomisationCharge": "text",
  "MobileReady": "text",
  "PhoneTracking": "text",
  "PromoCodeTracking": "text",
  "TopSeller": "text",
  "RestrictedMediaPartners": [
    "text"
  ],
  "RestrictedMediaPartnerGroups": [
    "text"
  ],
  "DealDescription": "text",
  "DealState": "text",
  "DealType": "text",
  "DealScope": "text",
  "DealProducts": [
    "text"
  ],
  "DealCategories": "text",
  "DiscountType": "text",
  "DiscountAmount": "text",
  "DiscountCurrency": "text",
  "DiscountPercent": "text",
  "DiscountMaximumPercent": "text",
  "DiscountPercentRangeStart": "text",
  "DiscountPercentRangeEnd": "text",
  "Gift": "text",
  "RebateAmount": "text",
  "RebateCurrency": "text",
  "DealDefaultPromoCode": "text",
  "MinimumPurchaseAmount": "text",
  "MinimumPurchaseAmountCurrency": "text",
  "MaximumSavingsAmount": "text",
  "MaximumSavingsCurrency": "text",
  "BogoBuyQuantity": "text",
  "BogoBuyScope": "text",
  "BogoBuyName": "text",
  "BogoBuyImageUrl": "text",
  "BogoGetQuantity": "text",
  "BogoGetScope": "text",
  "BogoGetDiscountType": "text",
  "BogoGetName": "text",
  "BogoGetImageUrl": "text",
  "BogoGetDiscountAmount": "text",
  "BogoGetDiscountCurrency": "text",
  "BogoGetDiscountPercent": "text",
  "PurchaseLimitQuantity": "text",
  "DealStartDate": "2026-07-13T15:31:34.657Z",
  "DealEndDate": "2026-07-13T15:31:34.657Z",
  "SynchAdsPromoCodes": "text",
  "DealRestrictedMediaPartners": [
    "text"
  ],
  "DealRestrictedMediaPartnerGroups": [
    "text"
  ],
  "Uri": "/Advertisers/{AccountSID}/Ads/892081"
}

Update an ad

put

Updates an existing ad with the provided parameters.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

IdstringRequired

Body

NamestringOptionalExample: Summer Sale 2020 250x250

DescriptionstringOptionalExample: Our best deals this summer creative.

LabelsstringOptionalExample: sale,US

AllowDeepLinkingstringOptionalExample: true

LandingPagestringOptionalExample: http://www.test.com/6234652

LanguagestringOptional

Example: ENGLISH

LimitedTimeStartDatestring · date-timeOptionalExample: 2026-09-16T17:01:28-07:00

LimitedTimeEndDatestring · date-timeOptionalExample: 2026-12-31T23:59:59-07:00

BannerAlternativeTagstringOptionalExample: summersale

CustomAdServingUrlstringOptional

DealIdstringOptional

CouponAllowCustomPromoCodebooleanOptional

Whether the ad allows partners to use a custom promo code (instead of the default coupon code).

Example: false

CustomisationChargenumber · decimalOptional

The charge applied when partners customise this ad.

Example: 0

SeasonstringOptional

Example: SUMMER

Responses

200

Success response.

application/json

StatusstringOptional

Uristring · uri-referenceOptional

put/Advertisers/{AccountSID}/Ads/{Id}

cURL

curl -L \
  --request PUT \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Ads/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'

200

Success response.

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

PreviousAds NextModels

Last updated 1 month ago