> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/reference/ads/ads.md).

# Ads

## List All Ads

> Lists existing ads, returned by creation date with the most recently created ad appearing first. The list can be filtered by various parameters.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Ads","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Ad":{"type":"object","properties":{"Id":{"type":"string","description":"The unique impact.com identifier for the ad."},"Name":{"type":"string"},"Description":{"type":"string"},"CampaignId":{"type":"string"},"CampaignName":{"type":"string"},"AdType":{"type":"string","description":"The type of ad creative.","enum":["BANNER","TEXT_LINK","COUPON"]},"LandingPage":{"type":"string","format":"uri"},"MobileFallbacks":{"type":"object","properties":{"Android":{"type":"string","description":"The SystemAppId of the Android mobile app."},"IOS":{"type":"string","description":"The SystemAppId of the iOS mobile app."}}},"DateCreated":{"type":"string","format":"date-time","description":"The date and time when the ad was created."},"DateLastUpdated":{"type":"string","format":"date-time","description":"The date and time when the ad was last updated."},"CustomAdServingUrl":{"type":"string","format":"uri"},"IabAdUnit":{"type":"string","description":"The IAB ad unit size classification."},"ThirdPartyServableAdCreativeHeight":{"type":"string"},"ThirdPartyServableAdCreativeWidth":{"type":"string"},"BannerAlternativeTag":{"type":"string"},"LinkText":{"type":"string"},"CouponLinkName":{"type":"string"},"GetHtmlCodeType":{"type":"string","description":"The format of the HTML code generated for the ad.","enum":["HTML_AND_IFRAME","IFRAME_ONLY"]},"Labels":{"type":"string","description":"Comma-separated key terms."},"AllowDeepLinking":{"type":"string","description":"Whether the ad supports deep linking to mobile app content."},"Language":{"type":"string","description":"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`."},"LimitedTimeStartDate":{"type":"string","format":"date-time","description":"The start date of a limited-time promotion associated with this ad."},"LimitedTimeEndDate":{"type":"string","format":"date-time","description":"The end date of a limited-time promotion associated with this ad."},"RestrictedMediaPartners":{"type":"array","description":"List of partner IDs that are restricted from using this ad.","items":{"type":"string"}},"RestrictedMediaPartnerGroups":{"type":"array","description":"List of partner group names that are restricted from using this ad.","items":{"type":"string"}},"Season":{"type":"string","description":"The seasonal theme associated with the ad. 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`."},"Uri":{"type":"string","format":"uri-reference","description":"The URI of this ad resource."},"DealId":{"type":"string","description":"The unique identifier of the deal associated with this ad."},"DealName":{"type":"string","description":"The name of the deal associated with this ad."},"AdCodeTemplate":{"type":"string"},"CouponAllowCustomPromoCode":{"type":"string"},"CustomisationCharge":{"type":"string"},"MobileReady":{"type":"string","description":"Whether the ad is optimized for mobile devices."},"PhoneTracking":{"type":"string","description":"Whether phone call tracking is enabled for the ad."},"PromoCodeTracking":{"type":"string","description":"Whether promo code tracking is enabled for the ad."},"TopSeller":{"type":"string","description":"Whether the ad is marked as a top seller."},"DealDescription":{"type":"string"},"DealState":{"type":"string"},"DealType":{"type":"string"},"DealScope":{"type":"string"},"DealProducts":{"type":"array","items":{"type":"string"}},"DealCategories":{"type":"string"},"DiscountType":{"type":"string"},"DiscountAmount":{"type":"string"},"DiscountCurrency":{"type":"string"},"DiscountPercent":{"type":"string"},"DiscountMaximumPercent":{"type":"string"},"DiscountPercentRangeStart":{"type":"string"},"DiscountPercentRangeEnd":{"type":"string"},"Gift":{"type":"string"},"RebateAmount":{"type":"string"},"RebateCurrency":{"type":"string"},"DealDefaultPromoCode":{"type":"string"},"MinimumPurchaseAmount":{"type":"string"},"MinimumPurchaseAmountCurrency":{"type":"string"},"MaximumSavingsAmount":{"type":"string"},"MaximumSavingsCurrency":{"type":"string"},"BogoBuyQuantity":{"type":"string"},"BogoBuyScope":{"type":"string"},"BogoBuyName":{"type":"string"},"BogoBuyImageUrl":{"type":"string"},"BogoGetQuantity":{"type":"string"},"BogoGetScope":{"type":"string"},"BogoGetDiscountType":{"type":"string"},"BogoGetName":{"type":"string"},"BogoGetImageUrl":{"type":"string"},"BogoGetDiscountAmount":{"type":"string"},"BogoGetDiscountCurrency":{"type":"string"},"BogoGetDiscountPercent":{"type":"string"},"PurchaseLimitQuantity":{"type":"string"},"DealStartDate":{"type":"string","format":"date-time"},"DealEndDate":{"type":"string","format":"date-time"},"SynchAdsPromoCodes":{"type":"string"},"DealRestrictedMediaPartners":{"type":"array","items":{"type":"string"}},"DealRestrictedMediaPartnerGroups":{"type":"array","items":{"type":"string"}}}}}},"paths":{"/Advertisers/{AccountSID}/Ads":{"get":{"summary":"List All Ads","description":"Lists existing ads, returned by creation date with the most recently created ad appearing first. The list can be filtered by various parameters.","operationId":"listAds","tags":["Ads"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"CampaignId","in":"query","schema":{"type":"string"},"description":"Filter ads by a specific campaign (program) ID."},{"name":"Type","in":"query","schema":{"type":"string","enum":["BANNER","TEXT_LINK","COUPON"]},"description":"Filter ads by their type."},{"name":"DealId","in":"query","schema":{"type":"string"},"description":"Filter ads associated with a specific deal ID."},{"name":"MobileReady","in":"query","schema":{"type":"boolean"},"description":"Filter ads based on whether they are optimized for mobile."},{"name":"DateCreatedStart","in":"query","schema":{"type":"string","format":"date-time"},"description":"Start of the date range for when ads were created."},{"name":"DateCreatedEnd","in":"query","schema":{"type":"string","format":"date-time"},"description":"End of the date range for when ads were created."},{"name":"DateLastUpdatedStart","in":"query","schema":{"type":"string","format":"date-time"},"description":"Start of the date range for when ads were last updated."},{"name":"DateLastUpdatedEnd","in":"query","schema":{"type":"string","format":"date-time"},"description":"End of the date range for when ads were last updated."}],"responses":{"200":{"description":"A paginated list of ad objects.","content":{"application/json":{"schema":{"type":"object","properties":{"@page":{"type":"string"},"Ads":{"type":"array","items":{"$ref":"#/components/schemas/Ad"}}}}}}}}}}}}
```

## Create an Ad

> Creates a new Banner, Coupon, or Text Link ad. Use \`multipart/form-data\` if uploading a creative file, otherwise use \`application/x-www-form-urlencoded\`.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Ads","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"AdCreateUpdate":{"type":"object","description":"Schema for creating and updating an Ad. Some fields are conditionally required based on AdType.","required":["Name","CampaignId","AdType","Language"],"properties":{"Name":{"type":"string"},"CampaignId":{"type":"string"},"AdType":{"type":"string","enum":["BANNER","TEXT_LINK","COUPON"]},"Language":{"type":"string","description":"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`."},"Description":{"type":"string"},"LandingPage":{"type":"string","format":"uri"},"CustomAdServingUrl":{"type":"string","format":"uri","description":"Required for BANNER if not using AdCodeTemplate or BannerCreativeFile."},"AdCodeTemplate":{"type":"string","description":"Required for BANNER if not using CustomAdServingUrl or BannerCreativeFile."},"BannerCreativeFile":{"type":"string","format":"binary","description":"Creative file for a BANNER ad. Use multipart/form-data."},"CouponLinkName":{"type":"string","description":"Required for COUPON ad type."},"CouponAllowCustomPromoCode":{"type":"boolean","description":"Whether the ad allows partners to use a custom promo code (instead of the default coupon code)."},"CustomisationCharge":{"type":"number","format":"decimal","description":"The charge applied when partners customise this ad."},"LinkText":{"type":"string","description":"Required for TEXT_LINK ad type."},"IabAdUnit":{"type":"string"},"ThirdPartyServableAdCreativeHeight":{"type":"string"},"ThirdPartyServableAdCreativeWidth":{"type":"string"},"BannerAlternativeTag":{"type":"string","description":"Only for BANNER ad type."},"GetHtmlCodeType":{"type":"string","enum":["HTML_AND_IFRAME","IFRAME_ONLY"]},"Labels":{"type":"string"},"AllowDeepLinking":{"type":"string"},"LimitedTimeStartDate":{"type":"string","format":"date-time"},"LimitedTimeEndDate":{"type":"string","format":"date-time"},"TargetMediaPartners":{"type":"array","items":{"type":"string"},"description":"Array of partner IDs to restrict the ad to."},"TargetMediaPartnerGroups":{"type":"array","items":{"type":"string"},"description":"Array of partner group IDs to restrict the ad to."},"MobileFallbacks":{"type":"object","properties":{"Android":{"type":"string"},"IOS":{"type":"string"}}},"Season":{"type":"string","description":"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`."},"MobileReady":{"type":"string","description":"Whether the ad is optimized for mobile devices."},"PhoneTracking":{"type":"string","description":"Whether phone call tracking is enabled for the ad."},"PromoCodeTracking":{"type":"string","description":"Whether promo code tracking is enabled for the ad."},"TopSeller":{"type":"string","description":"Whether the ad is marked as a top seller."},"DealId":{"type":"string","description":"The ID of the deal to associate with this ad."}}}}},"paths":{"/Advertisers/{AccountSID}/Ads":{"post":{"summary":"Create an Ad","description":"Creates a new Banner, Coupon, or Text Link ad. Use `multipart/form-data` if uploading a creative file, otherwise use `application/x-www-form-urlencoded`.","operationId":"createAd","tags":["Ads"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The details of the ad to create.","required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/AdCreateUpdate"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AdCreateUpdate"}}}},"responses":{"200":{"description":"The ad was created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"Status":{"type":"string"},"Uri":{"type":"string","format":"uri-reference"}}}}}}}}}}}
```

## Get Ad Details

> Retrieves the details of an existing ad by its unique impact.com Ad ID.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Ads","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Ad":{"type":"object","properties":{"Id":{"type":"string","description":"The unique impact.com identifier for the ad."},"Name":{"type":"string"},"Description":{"type":"string"},"CampaignId":{"type":"string"},"CampaignName":{"type":"string"},"AdType":{"type":"string","description":"The type of ad creative.","enum":["BANNER","TEXT_LINK","COUPON"]},"LandingPage":{"type":"string","format":"uri"},"MobileFallbacks":{"type":"object","properties":{"Android":{"type":"string","description":"The SystemAppId of the Android mobile app."},"IOS":{"type":"string","description":"The SystemAppId of the iOS mobile app."}}},"DateCreated":{"type":"string","format":"date-time","description":"The date and time when the ad was created."},"DateLastUpdated":{"type":"string","format":"date-time","description":"The date and time when the ad was last updated."},"CustomAdServingUrl":{"type":"string","format":"uri"},"IabAdUnit":{"type":"string","description":"The IAB ad unit size classification."},"ThirdPartyServableAdCreativeHeight":{"type":"string"},"ThirdPartyServableAdCreativeWidth":{"type":"string"},"BannerAlternativeTag":{"type":"string"},"LinkText":{"type":"string"},"CouponLinkName":{"type":"string"},"GetHtmlCodeType":{"type":"string","description":"The format of the HTML code generated for the ad.","enum":["HTML_AND_IFRAME","IFRAME_ONLY"]},"Labels":{"type":"string","description":"Comma-separated key terms."},"AllowDeepLinking":{"type":"string","description":"Whether the ad supports deep linking to mobile app content."},"Language":{"type":"string","description":"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`."},"LimitedTimeStartDate":{"type":"string","format":"date-time","description":"The start date of a limited-time promotion associated with this ad."},"LimitedTimeEndDate":{"type":"string","format":"date-time","description":"The end date of a limited-time promotion associated with this ad."},"RestrictedMediaPartners":{"type":"array","description":"List of partner IDs that are restricted from using this ad.","items":{"type":"string"}},"RestrictedMediaPartnerGroups":{"type":"array","description":"List of partner group names that are restricted from using this ad.","items":{"type":"string"}},"Season":{"type":"string","description":"The seasonal theme associated with the ad. 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`."},"Uri":{"type":"string","format":"uri-reference","description":"The URI of this ad resource."},"DealId":{"type":"string","description":"The unique identifier of the deal associated with this ad."},"DealName":{"type":"string","description":"The name of the deal associated with this ad."},"AdCodeTemplate":{"type":"string"},"CouponAllowCustomPromoCode":{"type":"string"},"CustomisationCharge":{"type":"string"},"MobileReady":{"type":"string","description":"Whether the ad is optimized for mobile devices."},"PhoneTracking":{"type":"string","description":"Whether phone call tracking is enabled for the ad."},"PromoCodeTracking":{"type":"string","description":"Whether promo code tracking is enabled for the ad."},"TopSeller":{"type":"string","description":"Whether the ad is marked as a top seller."},"DealDescription":{"type":"string"},"DealState":{"type":"string"},"DealType":{"type":"string"},"DealScope":{"type":"string"},"DealProducts":{"type":"array","items":{"type":"string"}},"DealCategories":{"type":"string"},"DiscountType":{"type":"string"},"DiscountAmount":{"type":"string"},"DiscountCurrency":{"type":"string"},"DiscountPercent":{"type":"string"},"DiscountMaximumPercent":{"type":"string"},"DiscountPercentRangeStart":{"type":"string"},"DiscountPercentRangeEnd":{"type":"string"},"Gift":{"type":"string"},"RebateAmount":{"type":"string"},"RebateCurrency":{"type":"string"},"DealDefaultPromoCode":{"type":"string"},"MinimumPurchaseAmount":{"type":"string"},"MinimumPurchaseAmountCurrency":{"type":"string"},"MaximumSavingsAmount":{"type":"string"},"MaximumSavingsCurrency":{"type":"string"},"BogoBuyQuantity":{"type":"string"},"BogoBuyScope":{"type":"string"},"BogoBuyName":{"type":"string"},"BogoBuyImageUrl":{"type":"string"},"BogoGetQuantity":{"type":"string"},"BogoGetScope":{"type":"string"},"BogoGetDiscountType":{"type":"string"},"BogoGetName":{"type":"string"},"BogoGetImageUrl":{"type":"string"},"BogoGetDiscountAmount":{"type":"string"},"BogoGetDiscountCurrency":{"type":"string"},"BogoGetDiscountPercent":{"type":"string"},"PurchaseLimitQuantity":{"type":"string"},"DealStartDate":{"type":"string","format":"date-time"},"DealEndDate":{"type":"string","format":"date-time"},"SynchAdsPromoCodes":{"type":"string"},"DealRestrictedMediaPartners":{"type":"array","items":{"type":"string"}},"DealRestrictedMediaPartnerGroups":{"type":"array","items":{"type":"string"}}}}}},"paths":{"/Advertisers/{AccountSID}/Ads/{AdId}":{"get":{"summary":"Get Ad Details","description":"Retrieves the details of an existing ad by its unique impact.com Ad ID.","operationId":"getAdById","tags":["Ads"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"AdId","in":"path","required":true,"description":"The unique identifier for the ad.","schema":{"type":"string"}}],"responses":{"200":{"description":"An ad object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ad"}}}}}}}}}
```

## Update an Ad

> Updates an existing ad, including its creative file if needed. Use \`multipart/form-data\` if uploading a creative file.

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Ads","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"AdCreateUpdate":{"type":"object","description":"Schema for creating and updating an Ad. Some fields are conditionally required based on AdType.","required":["Name","CampaignId","AdType","Language"],"properties":{"Name":{"type":"string"},"CampaignId":{"type":"string"},"AdType":{"type":"string","enum":["BANNER","TEXT_LINK","COUPON"]},"Language":{"type":"string","description":"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`."},"Description":{"type":"string"},"LandingPage":{"type":"string","format":"uri"},"CustomAdServingUrl":{"type":"string","format":"uri","description":"Required for BANNER if not using AdCodeTemplate or BannerCreativeFile."},"AdCodeTemplate":{"type":"string","description":"Required for BANNER if not using CustomAdServingUrl or BannerCreativeFile."},"BannerCreativeFile":{"type":"string","format":"binary","description":"Creative file for a BANNER ad. Use multipart/form-data."},"CouponLinkName":{"type":"string","description":"Required for COUPON ad type."},"CouponAllowCustomPromoCode":{"type":"boolean","description":"Whether the ad allows partners to use a custom promo code (instead of the default coupon code)."},"CustomisationCharge":{"type":"number","format":"decimal","description":"The charge applied when partners customise this ad."},"LinkText":{"type":"string","description":"Required for TEXT_LINK ad type."},"IabAdUnit":{"type":"string"},"ThirdPartyServableAdCreativeHeight":{"type":"string"},"ThirdPartyServableAdCreativeWidth":{"type":"string"},"BannerAlternativeTag":{"type":"string","description":"Only for BANNER ad type."},"GetHtmlCodeType":{"type":"string","enum":["HTML_AND_IFRAME","IFRAME_ONLY"]},"Labels":{"type":"string"},"AllowDeepLinking":{"type":"string"},"LimitedTimeStartDate":{"type":"string","format":"date-time"},"LimitedTimeEndDate":{"type":"string","format":"date-time"},"TargetMediaPartners":{"type":"array","items":{"type":"string"},"description":"Array of partner IDs to restrict the ad to."},"TargetMediaPartnerGroups":{"type":"array","items":{"type":"string"},"description":"Array of partner group IDs to restrict the ad to."},"MobileFallbacks":{"type":"object","properties":{"Android":{"type":"string"},"IOS":{"type":"string"}}},"Season":{"type":"string","description":"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`."},"MobileReady":{"type":"string","description":"Whether the ad is optimized for mobile devices."},"PhoneTracking":{"type":"string","description":"Whether phone call tracking is enabled for the ad."},"PromoCodeTracking":{"type":"string","description":"Whether promo code tracking is enabled for the ad."},"TopSeller":{"type":"string","description":"Whether the ad is marked as a top seller."},"DealId":{"type":"string","description":"The ID of the deal to associate with this ad."}}}}},"paths":{"/Advertisers/{AccountSID}/Ads/{AdId}":{"put":{"summary":"Update an Ad","description":"Updates an existing ad, including its creative file if needed. Use `multipart/form-data` if uploading a creative file.","operationId":"updateAd","tags":["Ads"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"AdId","in":"path","required":true,"description":"The unique identifier for the ad to update.","schema":{"type":"string"}}],"requestBody":{"description":"The ad properties to update.","required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/AdCreateUpdate"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AdCreateUpdate"}}}},"responses":{"200":{"description":"The ad was updated successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"Status":{"type":"string"},"Uri":{"type":"string","format":"uri-reference"}}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/reference/ads/ads.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.