OSosano
cmp

Update Cookie Consent Configuration

Update an existing Cookie Consent Configuration.

patch/v1/cookie-consent/configs/{configId}

Request

Path parameters

configIdstring required

The identifier of the Cookie Consent Configuration to be updated.

Request body

namestring

The name of the configuration.

domainsstring[]

A list of domains (cannot be null or empty) that are permitted to host the configuration.

orgIdsstring[]

A list of organization IDs that the configuration is associated with. If omitted or empty, the configuration is associated with the root organization of the customerId that created the API key used to make the request.

mode'debug' | 'permissive' | 'production'

The compliance mode for the configuration.

  • debug: Discovery/Listener Mode - Script and cookie information will be gathered for categorization, but blocking will not occur and the consent dialog will not be displayed.
  • permissive: Permissive Mode - The consent dialog will be displayed. All <i>uncategorized</i> scripts will be reported as discoveries and allowed regardless of consent given. All <i>categorized</i> scripts will be allowed or blocked based on the user selection.
  • production: Strict Mode <b>(recommended)</b> - The consent dialog will be displayed, and all uncategorized scripts will be blocked until they have been classified.

Note: It is recommended that all discovered scripts & cookies are classified before changing the mode to production as all unclassified entities will be blocked. For more information, see Compliance Mode Definitions in the Cmp Setup Guide

Response

Success

namestring

The name of the configuration.

domainsstring[]

A list of domains (cannot be null or empty) that are permitted to host the configuration.

orgIdsstring[]

A list of organization IDs that the configuration is associated with. If omitted or empty, the configuration is associated with the root organization of the customerId that created the API key used to make the request.

mode'debug' | 'permissive' | 'production'

The compliance mode for the configuration.

  • debug: Discovery/Listener Mode - Script and cookie information will be gathered for categorization, but blocking will not occur and the consent dialog will not be displayed.
  • permissive: Permissive Mode - The consent dialog will be displayed. All <i>uncategorized</i> scripts will be reported as discoveries and allowed regardless of consent given. All <i>categorized</i> scripts will be allowed or blocked based on the user selection.
  • production: Strict Mode <b>(recommended)</b> - The consent dialog will be displayed, and all uncategorized scripts will be blocked until they have been classified.

Note: It is recommended that all discovered scripts & cookies are classified before changing the mode to production as all unclassified entities will be blocked. For more information, see Compliance Mode Definitions in the Cmp Setup Guide

createdinteger

The unix epoch timestamp when the configuration was created.

updatedinteger

The unix epoch timestamp when the configuration was last updated.

publishStatus'unpublished' | 'in-progress' | 'published' | 'outdated' | 'error'
lastPublishedinteger

The unix epoch timestamp when the configuration was last published.

publishedRevisioninteger
tattleRecordStoppedboolean
configIdstring uuid required

The configuration ID.

customerIdstring

The customer ID associated with the configuration.

Changes

No recorded changes to this operation across all 1 revision of this API.