API Reference

Update an ad

You can update an existing ad using this endpoint, including any creative files used.

Note: If you want impact.com to host your creative asset, like an image or video, then make sure to send the request with the Content-Type multipart/form-data rather than the more typical application/x-www-form-urlencoded.


Parameters

Name optional

Name of the routing rule.

Description optional

Additional information about the ad available to partners.

Labels optional

Key terms to help partners find a particular ad in impact.com.

AllowDeepLinking optional

Whether partners can override the ad's landing page.

LandingPage optional

The URL for the landing page.

MobileFallbacks optional

Choose what happens when someone clicks your ad but doesn’t have your app installed. If the system sees that the app isn’t on their device, it will send them to the app’s download page instead.

Language optional

What language the ad is hosted in.

View possible enum values
AFRIKAANSAfrikaans
ARABICالعربية
BULGARIANбългарски
CHINESE中文(简体)
CHINESE_TRADITIONAL中文(繁體)
CZECHčeština
DANISHDansk
DUTCHNederlands
ENGLISHEnglish (United States)
ENGLISH_GBEnglish (United Kingdom)
ANGLISH_AUEnglish (Australia)
ENGLISH_CAEnglish (Canada)
ENGLISH_NZEnglish (New Zealand)
ENGLISH_ZAEnglish (South Africa)
ESTONIANeesti
FILIPINOFilipino
FINISHsuomi
FRENCHFrançais
FRENCH_CAFrançais (Canada)
GERMANDeutsch
HEBREWעברית
HINDIहिन्दी
INDONESIANBahasa Indonesia
ITALIANItaliano
JAPANESE日本語
KOREAN 한국어
LATVIANlatviešu
LITHUANIAN lietuvių kalba
MALAY Malay
MALTESEMalti
NORWEGIANNorsk
PORTUGUESEPortuguês
PORTUGUESE_BRPortuguês (Brasil)
POLISHPolski
RUSSIANРусский
SLOVENIAN slovenščina
SPANISHEspañol
SPANISH_MX Español (Mexico)
SWEDISH Svensk
THAIไทย
TURKISHTürkçe
VIETNAMESETiếng Việt

LimitedTimeStartDate optional

When an ad will become available for use. See ISO 8601.

LimitedTimeEndDate optional

When an ad is no longer available for use. See ISO 8601.

BannerCreativeFile optional

Allows you to add or change the banner ad's creative image. Can only be used for AdType: BANNER.

Requirements:

  • The creative file must be an image (jpg, jpeg, png, gif) with a maximum file size of 25MB.
  • The request must include the header Content-Type=multipart/form-data
  • The input is a reference to the file in the user’s machine. Must use the --form prefix in a cURL call.

BannerAlternativeTag optional

Alternative text that will be shown if the ad's creative cannot be displayed. Can only use when AdType: BANNER.

CustomAdServingUrl optional

If you're not using impact.com for ad hosting, this is the URL where the ad's creative is stored. Can only use when AdType: BANNER.

IabAdUnit optional

IAB's official unit type for the ad.

ThirdPartyServableAdCreativeHeight optional

The ad's creative height (in pixels).

ThirdPartyServableAdCreativeWidth optional

The ad's creative width (in pixels).

More Parameters

Click to view...

MobileReady optional

Whether the ad is optimized for mobile devices.

AdCodeTemplate optional

A template for serving ad code from a third-party server.

DealId optional

Unique identifier for for deal associated with the ad.

DealName string

Name of the deal associated with the ad.

Returns

Returns the status of the call and the URI to the ad object.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSid>/Ads/892081' \
  -X PUT \
  -u '<AccountSid>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -F 'Description=My new description.' \
  -F 'LimitedTimeStartDate=2020-10-30T00:00:00Z' \
  -F 'LimitedTimeEndDate=2020-11-05T00:00:00Z'
  -F 'BannerCreativeFile=@"/Users/CarrieOakey/MyNewCreative.png"'

Example Response

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSid>/Ads/892081"
}