Skip to main content

Update a specific region of Banner settings by region

To change a specific section of regions for your banner settings is simple, you just have to send a PUT request to our API to the endpoint:

https://api.platform.illow.io/open-api/v1/banner-regions/:siteId/:region
info

Don't forget to include your Access Key in the X-API-Key header of all your requests.

info

Don't forget to replace the URL parameters: :siteId, :region.

Request Path

PropertyTypeRequired?Description
siteIdstringYesThe company site ID
regionstringYesThe region where the subregion to delete is located

Request Body

Format: JSON

Region Object

PropertyTypeRequired?Description
defaultstringYesA type of default banner for the region in case you do not have a specific one assigned for that Country/State
regionsList of countriesNoCountry object with its corresponding banner

List Country or State Object

PropertyTypeRequired?Description
ISO Country/State codestringYesThe type of banner you want to display in that region

Examples

{
"regions": {
"ca": "ccpaBanner",
"va": "fullyCompliantBanner",
"co": "fullyCompliantBanner",
"in": "fullyCompliantBanner",
"ut": "ccpaBanner"
},
"default": "fullyCompliantBanner"
}

Interactive API Reference

Take a look at our interactive Swagger Site!