Updating Banner settings by region

By default, illow will automatically display these settings. However, you have the option to customize where to show each banner and configure personalized settings.

    "us": {
        "regions": {
            "ca": "ccpaBanner",
            "va": "fullyCompliantBanner",
            "co": "fullyCompliantBanner",
            "in": "fullyCompliantBanner",
            "ut": "ccpaBanner"
        },
        "default": "fullyCompliantBanner"// It is necessary to load a default option, which will be used for the countries/states of the same region that do not have a specific banner assigned
    },
    "gl": {
        "regions": {
            "br": "gdprBanner",
            "uy": "gdprBanner",
            "mx": "fullyCompliantBanner",
            "co": "fullyCompliantBanner",
            "au": "fullyCompliantBanner",
            "nz": "fullyCompliantBanner",
            "ca": "gdprBanner",
            "ph": "fullyCompliantBanner",
            "jp": "fullyCompliantBanner",
            "tr": "gdprBanner",
            "th": "gdprBanner",
            "kr": "gdprBanner",
            "pe": "fullyCompliantBanner"
        },
        "default": "fullyCompliantBanner" // It is necessary to load a default option, which will be used for the countries/states of the same region that do not have a specific banner assigned
    },
    "eu": {
        "regions": {
            "ru": "fullyCompliantBanner",
            "ch": "gdprBanner",
            "gb": "gdprBanner"
        },
        "default": "gdprBanner"// It is necessary to load a default option, which will be used for the countries/states of the same region that do not have a specific banner assigned
    },

To update your banner regions 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

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 with your site ID.

Request Path

Property	Type	Required?	Description
siteId	string	Yes	The company site ID

Request Body

Format: JSON

Property	Type	Required?	Description
us	Region Object	Yes	Object format to update banner information by regions for USA.
gl	Region Object	Yes	Object format to update banner information by regions for the rest of the World
eu	Region Object	Yes	Object format to update banner information by regions for EU.

Region Object

Property	Type	Required?	Description
default	string	Yes	A type of default banner for the region in case you do not have a specific one assigned for that Country/State
regions	List	No	Country object with its corresponding banner

List Country or State Object

Property	Type	Required?	Description
ISO Country/State code	string	Yes	The type of banner you want to display in that region

caution

The banner types we support are: gdprBanner, fullyCompliantBanner and ccpaBanner. Therefore, when sending your request, it is important that you check the values sent.

Interactive API Reference

Take a look at our interactive Swagger Site!