Update an ad

Updates an existing ad.

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 kind a particular ad in impact.com.


AllowDeepLinking optional

Whether partners can override the ad's landing page.


LandingPage optional

Landing page's URL for the ad this attribute is contained in.


MobileFallbacks optional

Set up which Mobile App Event Type the system directs users to when it detects your app is not installed on the user's device. In the event the system detects the mobile device hitting the ad doesn’t have the particular app installed, it will fall back to the app’s download URL 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.


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 bypassing impact.com ad hosting, this is the URL location of the ad's creative. 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

Template to serve the 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' \
  -d 'Description=My new description.' \
  -d 'LimitedTimeStartDate=2020-10-30T00:00:00Z' \
  -d 'LimitedTimeEndDate=2020-11-05T00:00:00Z'

Example Response


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