cmp

Create New Cookie Consent Configuration

Changed on Nov 6, 2026

Create a new Cookie Consent Configuration.

post/v1/cookie-consent/configs

Request

Base URL
https://api.osano.com
Auth
API key in header x-osano-api-key
TypeScript
https://skmtc.dev/osano/apis/osano-api-reference/docs/v1/cookie-consent/configs/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

The name of the configuration.

domainsstring[] required

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' required

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 uncategorized scripts will be reported as discoveries and allowed regardless of consent given. All categorized scripts will be allowed or blocked based on the user selection.
production: Strict Mode (recommended) - 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[]

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 uncategorized scripts will be reported as discoveries and allowed regardless of consent given. All categorized scripts will be allowed or blocked based on the user selection.
production: Strict Mode (recommended) - The consent dialog will be displayed, and all uncategorized scripts will be blocked until they have been classified.

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

Nov 6, 2026ac31099cf83e Revision changes
- warning
  removed the request property ///
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property //////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property //
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
May 12, 20264fc37598750d Revision changes
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property //////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property /////
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  the request property ////// became nullable
- info
  request property ////// deprecated
- info
  request property ////// deprecated
- info
  request property ////// deprecated
- info
  request property ////// deprecated
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  response property allOf[CmpConfig]/configuration/palette/toggleButtonOffColor deprecated
- info
  response property allOf[CmpConfig]/configuration/palette/toggleButtonOnColor deprecated
- info
  response property allOf[CmpConfig]/configuration/palette/toggleOffBackgroundColor deprecated
- info
  response property allOf[CmpConfig]/configuration/palette/toggleOnBackgroundColor deprecated

Operation history (3 revisions)

Create New Cookie Consent Configuration

Request

Request body

Response 200OK

Changes

Response