Publish Script to Website

put

https://{hostname}/api/cmp/v1/domains/publish

Use this API to publish the script configuration options for the specified website.

👍
For more information, see Publishing and Implementing Cookie Consent Scripts.

Query Params

scriptType

string

enum

The type of script either production or test.

Allowed:

website

string

required

length ≤ 1024

The website domain to target for the operation.

Body Params

scriptVersion

string

(Optional) The SDK version to publish to. If not provided, the previously configured SDK version will be used.

languages

array of strings

length between 0 and 100

The list of language codes for localized content.

languages

publishIndividualLanguages

boolean

Defaults to false

This flag indicates whether to publish scripts for individual languages separately.

requireReconsent

boolean

Defaults to false

This flag indicates whether user reconsent is required.

regionRules

array of objects

length between 0 and 1000

(Optional) Individual geolocation rules to apply require reconsent to.

regionRules

suppressBannerEnabled

boolean

This flag indicates whether the consent banner display is suppressed.

suppressPCEnabled

boolean

This flag indicates whether the preference center display is suppressed.

gaTrackingEnabled

boolean

When toggle is ON, Google Analytics events will be created and passed based on user interaction. You can also choose for gaEvent tracking on the banner to be associated with the acceptance of a category. The data-ignore-ga='true' attribute will override this configuration. Google Analytics integration also required.

gaAssignCategory

string

Name of the category to assign to Google Analytics events. Use 'AS' for always send. Unnecessary unless gaTrackingEnabled is true.

autoblockEnabled

boolean

This flag indicates whether automatic blocking of cookies is enabled.

enableCommonTrackers

boolean

This flag indicates whether common tracking technologies are enabled.

commonTrackers

array of strings

enum

length between 0 and 100

Select the hosts that you want to autoblock. Only applicable when autoblockEnabled and enableCommonTrackers are true.

commonTrackers

sameSiteNone

boolean

Sets the cookies used SameSite attribute to 'None'

separateCookieByDomain

boolean

Only applicable when sameSiteNone is true.When cookies are created with partitioned state from an iframe, they are created specific to their top level site domain and are not shared with other top-level domains using the same iframe. This setting is ignored if sameSiteNone is false.

supportSPA

boolean

Enabling this allows you to force the banner to reload, the same as it would on an actual page change.

supportCSP

boolean

If enabled, the polyfill allows us to add inline styles, style tags with a nonce are allowed by the CSP

languageDetectionEnabled

boolean

This flag indicates whether automatic language detection is enabled.

languageDetectionVisitor

boolean

This flag indicates whether visitor-based language detection is enabled.

languageDetectionHtml

boolean

This flag indicates whether HTML-based language detection is enabled.

autoRefreshEnabled

boolean

Defaults to false

When a user makes any consent choice, the web page and consent banner will refresh automatically. This setting can further prevent unauthorized cookies from dropping without consent.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK

429Too Many Requests. For more information, see API Rate Limits.