Consent API Object

Overview

The consent object defines the user's explicit preferences regarding data collection and processing. It ensures that all downstream processing, reporting, and platform integrations respect the user's privacy choices.

Each property is a boolean that controls a specific category of data usage:

• analytics — consent for collecting data used in performance monitoring and usage statistics
• personalization — consent for collecting data used to tailor user experiences and customize content
• marketing — consent for collecting data used in advertising, remarketing, and campaign measurement

Complete Reference

consent object

analytics boolean required

info

Indicates the user’s explicit consent regarding the collection and processing of data for analytical purposes, such as performance monitoring, usage statistics, and service optimization.

analytics: true

personalization boolean required

info

Indicates the user’s explicit consent regarding the collection and processing of data for personalization purposes, enabling tailored experiences and content customization.

personalization: true

marketing boolean required

info

Indicates the user’s explicit consent regarding the collection and processing of data for marketing purposes, such as targeted advertising, remarketing, and campaign measurement.

marketing: true

Example

{
  "analytics": true,
  "personalization": false,
  "marketing": true
}