Configure consent and policy
configure_consentTurn on and set up the consent bar for a pixel.
Changing any setting makes a new policy version, and returning visitors are asked again. Returns the policy link and the script tag to put on the site.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pixel_id | Yes | pixel_id of the pixel to configure. Example: px_7a1b2c3d4e5f6a7b | |
| purposes | Yes | What the consent bar asks the visitor to allow. One or more of: analytics, resolution, newsletter, email_sharing, phone_sharing, partner_email, partner_calls, partner_sms. Include resolution, or no visitor is ever identified. Example: ["resolution", "analytics"] | |
| data_sharing | No | Optional. true if the site owner shares consented contact data with other parties, false if not. Shown in the hosted notice. Example: false | |
| controller_name | Yes | Name of the business or person that owns the site. It is shown in the consent bar as the party asking the visitor for permission. 1 to 200 characters. Example: Example Shop LLC | |
| controller_type | No | Optional. One of company, person or organization. Describes the site owner in the hosted notice. Example: company | |
| site_policy_url | No | Optional. HTTPS address of the site's own privacy policy. The bar links to it, and the hosted notice becomes a short add-on about identification. Leave empty to use the hosted notice on its own. Example: https://shop.example.com/privacy | |
| contact_channels | No | Optional. How the site owner may contact a visitor who consents. Any of: email, phone, sms, agentic. Example: ["email"] | |
| disclosed_parties | No | Optional. Names of the other parties the site owner wants the hosted notice to list, one name per item. Example: ["Example CRM Inc."] | |
| controller_contact | No | Optional. Email address or web address where visitors can reach the site owner about their data. Shown in the hosted notice. Example: privacy@example.com | |
| controller_jurisdiction | No | Optional. Where the site owner is based, as plain text, such as a country or US state. Shown in the hosted notice. Example: Florida, USA |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| snippet | Yes | ||
| pixel_id | Yes | ||
| purposes | Yes | ||
| policy_url | Yes | ||
| policy_hash | Yes | ||
| policy_version | Yes | ||
| consent_enabled | Yes |