v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Scripts

Publish Script to Website

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

👍

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

put/api/cmp/v1/domains/publish

Query parameters

scriptType'production' | 'test'

The type of script either production or test.

websitestring required

The website domain to target for the operation.

Request body

autoblockEnabledboolean

Auto-blocking leverages an additional script that must be added to the website to block tracking technologies based on the source setting them. Setting this flag to ’True’ will indicate this script should be published as well. If not specified, this is assumed ‘False’.

enableCommonTrackersboolean

By default, this flag is ‘False’. Setting to ’True’ indicates to the auto-blocking script to automatically block known trackers.

languageDetectionEnabledboolean

Indicates whether to automatically detect the language of the website visitor. By default this is ’True’. If not specified, this will default to the last time it was published.

languageDetectionHtmlboolean

Indicates the script should detect the website visitors langauge based on the webpages language.

languageDetectionVisitorboolean

Indicates the script should detect the website visitors langauge based on their browser language. By default this is ’True’.

languagesstring[]

Only required if ‘publishIndividualLanguages=’True’. Indicates which languages to publish.

publishIndividualLanguagesboolean

By default, this flag is ‘False’. Setting to ’True’ indicates you only wish to publish a subset of langauges.

requireReconsentboolean

Indicates that website visitors should be reprompted with the Consent Management Platform. By default, this is set to ‘False’.

suppressBannerEnabledboolean

Indicates the banner is manually invoked on the page and should be suppressed upon on initial load. Usually used for SPAs. By default, this flag is ‘False’.

suppressPCEnabledboolean

Indicates the pref. Center is fetched only upon website visitor interaction with the banner. By default, this flag is ‘False’.

Example request

{
  "languageDetectionEnabled": true,
  "languageDetectionVisitor": true
}

Response

autoBlockingboolean

Auto-blocking leverages an additional script that must be added to the website to block tracking technologies based on the source setting them.

consentPolicyNamestring

The consent policy that is assigned to the website being published.

publishVersionstring

The last published version of the script.

publishedDatestring date-time

The date-time when the script was last published.

reconsentRequiredboolean

Indicates whether website visitors will be reprompted with the Consent Management Platform.

responseMsgstring

Response message indicating whether the publish was initiated successfully or it failed.

userNamestring

The tenant GUID of the user which initiated the scan.

Example response

{
  "consentPolicyName": "EU GeoRule",
  "publishVersion": "6.8.0",
  "publishedDate": "2002-05-31T14:17:26.598Z",
  "responseMsg": "Publish initiated successfully",
  "userName": "123e4567-e89b-12d3-a456-426614174000"
}