# CookieChimp Docs ## Docs - [Advanced Banner Overrides](https://docs.cookiechimp.com/docs/advanced/banner-overrides.md): Programmatically override the banner for advanced customization — geo-targeted tweaks, conditional UI changes, and custom tag-firing logic. - [JavaScript SDK](https://docs.cookiechimp.com/docs/advanced/callbacks-events.md): The complete client-side API — read the visitor's consent and the banner that was served, listen for consent events, and control the banner programmatically. Everything you can do from your own JavaScript, on one page. - [Content Security Policy (CSP)](https://docs.cookiechimp.com/docs/advanced/content-security-policy.md): Configure your Content Security Policy to work with CookieChimp. - [Custom CSS](https://docs.cookiechimp.com/docs/advanced/custom-css.md): Override the banner's styles using CSS variables and custom selectors. - [Custom Consent Button](https://docs.cookiechimp.com/docs/advanced/custom-update-consent-button.md): Add custom buttons or links for users to change their cookie preferences. - [Create account invitation](https://docs.cookiechimp.com/docs/api-reference/account-invitations/create-account-invitation.md): Invite someone to the current account and email them the invitation. - [Delete account invitation](https://docs.cookiechimp.com/docs/api-reference/account-invitations/delete-account-invitation.md): Cancel an account invitation. - [Get account invitation](https://docs.cookiechimp.com/docs/api-reference/account-invitations/get-account-invitation.md): Get account invitation by ID - [List account invitations](https://docs.cookiechimp.com/docs/api-reference/account-invitations/list-account-invitations.md): List pending invitations for the current account. Requires an account-scoped API token. - [Update account invitation](https://docs.cookiechimp.com/docs/api-reference/account-invitations/update-account-invitation.md): Update the name on an account invitation. The email address cannot be changed. - [Delete account user](https://docs.cookiechimp.com/docs/api-reference/account-users/delete-account-user.md): Remove a user from the current account. The account owner cannot be removed and returns a `422`. - [Get account user](https://docs.cookiechimp.com/docs/api-reference/account-users/get-account-user.md): Get account user by ID - [List account users](https://docs.cookiechimp.com/docs/api-reference/account-users/list-account-users.md): List the users that belong to the current account. Requires an account-scoped API token. - [Update account user](https://docs.cookiechimp.com/docs/api-reference/account-users/update-account-user.md): Update an account user's roles. - [Get account](https://docs.cookiechimp.com/docs/api-reference/account/get-account.md): Get an account by ID. Accepts partner, user, or account tokens. - [List accounts](https://docs.cookiechimp.com/docs/api-reference/account/list-accounts.md): List accounts. Accepts partner, user, or account tokens: a partner token lists every account under the partner's groups, a user token lists the accounts that user can access, and an account token lists just that account. - [Get AI action](https://docs.cookiechimp.com/docs/api-reference/ai-actions/get-ai-action.md): Get AI action by ID - [List AI actions](https://docs.cookiechimp.com/docs/api-reference/ai-actions/list-ai-actions.md): List the actions CookieChimp's AI has taken on this account's categories and storage items. Requires an account-scoped API token. - [Change password](https://docs.cookiechimp.com/docs/api-reference/auth/change-password.md): Change the password of the user the API token belongs to. The current password must be supplied. Requires a user API token. - [Log in](https://docs.cookiechimp.com/docs/api-reference/auth/login.md): Exchange a user's email and password for an API token. This is the only operation in this specification that does not require an `Authorization` header — the API serves a few other public routes, such as the widget and mobile SDK endpoints, that are not documented here. - [Log out](https://docs.cookiechimp.com/docs/api-reference/auth/logout.md): Sign the current user out. Pass `notification_token` to also remove a registered push notification token for that user. - [API Overview & Authentication](https://docs.cookiechimp.com/docs/api-reference/authentication.md): Access all the data on CookieChimp through our RESTful API. - [Create category](https://docs.cookiechimp.com/docs/api-reference/categories/create-category.md): Create a new category for the current account. - [Delete category](https://docs.cookiechimp.com/docs/api-reference/categories/delete-category.md): Delete category by ID. The category is soft-deleted and stops appearing in listings. - [Get category](https://docs.cookiechimp.com/docs/api-reference/categories/get-category.md): Get category by ID - [List categories](https://docs.cookiechimp.com/docs/api-reference/categories/list-categories.md): List all categories for the current account. Requires an account-scoped API token. - [Update category](https://docs.cookiechimp.com/docs/api-reference/categories/update-category.md): Update category by ID - [Get consent](https://docs.cookiechimp.com/docs/api-reference/consents/get-consent.md): Get consent by ID - [List consents](https://docs.cookiechimp.com/docs/api-reference/consents/list-consents.md): List consent records for the current account, newest first. Requires an account-scoped API token. - [Create group](https://docs.cookiechimp.com/docs/api-reference/groups/create-group.md): Create a new group under your partner. Requires a partner API token. - [Get group](https://docs.cookiechimp.com/docs/api-reference/groups/get-group.md): Get a group by ID. Requires a partner API token. - [List groups](https://docs.cookiechimp.com/docs/api-reference/groups/list-groups.md): List all groups for your partner. Requires a partner API token. - [Update group](https://docs.cookiechimp.com/docs/api-reference/groups/update-group.md): Update a group by ID. Requires a partner API token. Only `name` and `external_id` can be changed; the plan limits (`max_pageviews_per_month` and `max_unique_visitors_per_month`) are set at creation time and are ignored here. - [Partner API](https://docs.cookiechimp.com/docs/api-reference/partner-api.md): Manage groups and accounts programmatically using a partner API token. - [Single Sign-On (SSO)](https://docs.cookiechimp.com/docs/api-reference/sso.md): Integrate CookieChimp with your identity provider using OpenID Connect. - [Create storage item](https://docs.cookiechimp.com/docs/api-reference/storage-items/create-storage-item.md): Create a new storage item for the current account. - [Delete storage item](https://docs.cookiechimp.com/docs/api-reference/storage-items/delete-storage-item.md): Delete storage item by ID. The item is soft-deleted and stops appearing in listings. - [Get storage item](https://docs.cookiechimp.com/docs/api-reference/storage-items/get-storage-item.md): Get storage item by ID - [List storage items](https://docs.cookiechimp.com/docs/api-reference/storage-items/list-storage-items.md): List all storage items (cookies, local storage and session storage) for the current account. - [Update storage item](https://docs.cookiechimp.com/docs/api-reference/storage-items/update-storage-item.md): Update storage item by ID - [White-Labeling](https://docs.cookiechimp.com/docs/api-reference/whitelabeling.md): Customize CookieChimp's branding to match your platform. - [Block Scripts & Cookies](https://docs.cookiechimp.com/docs/block-scripts-cookies/script-attributes.md): Control which scripts run based on user consent using data attributes. - [FAQ](https://docs.cookiechimp.com/docs/faq.md): Answers to common questions about consent banners and cookie management. - [Banner Designer](https://docs.cookiechimp.com/docs/features/banner-designer.md): Design and configure your consent banner's layout, theme, and behavior. - [Block Iframes](https://docs.cookiechimp.com/docs/features/block-iframes.md): Block iframes from loading before consent and show a placeholder notice. - [Consent Records](https://docs.cookiechimp.com/docs/features/consent-records.md): Understand how consent records are stored, how privacy is maintained, and how to find user records. - [Identify Users](https://docs.cookiechimp.com/docs/features/identify-users.md): Match consent records with your application's user IDs. - [Multilingual Banners](https://docs.cookiechimp.com/docs/features/multilingual-banners.md): Understand language detection, overrides, and how to translate your consent banner. - [Vendor List Embed](https://docs.cookiechimp.com/docs/features/vendor-list-embed.md): Add an up-to-date vendor list to your cookie or privacy policy page. - [Vendor Management](https://docs.cookiechimp.com/docs/features/vendor-management.md): Organize categories, vendors, and storage items in CookieChimp. - [Vendor Scanning](https://docs.cookiechimp.com/docs/features/vendor-scanning.md): Understand how CookieChimp scans your website for vendors and storage items. - [Wildcard Cookies](https://docs.cookiechimp.com/docs/features/wildcard-cookies.md): Group similar storage items using wildcard patterns. - [Adobe Launch](https://docs.cookiechimp.com/docs/installation/adobe-launch.md): Set up a consent banner with Adobe Launch (Adobe Experience Platform Tags). - [Angular](https://docs.cookiechimp.com/docs/installation/angular.md): Install a consent banner in an Angular application. - [Astro](https://docs.cookiechimp.com/docs/installation/astro.md): Install a consent banner in an Astro site, with or without View Transitions. - [Bubble](https://docs.cookiechimp.com/docs/installation/bubble.md): Add a GDPR & CCPA compliant cookie consent banner to your Bubble.io no-code app with CookieChimp. Install via SEO/metatags settings. - [Carrd](https://docs.cookiechimp.com/docs/installation/carrd.md): Add a GDPR & CCPA compliant cookie consent banner to your Carrd one-page site with CookieChimp. Works with Carrd Pro using the Embed widget. - [How Long Does It Take to Set Up a CMP?](https://docs.cookiechimp.com/docs/installation/cmp-setup-guide.md): Set up CookieChimp in as little as 10 minutes. The fastest, easiest consent management platform to configure and deploy. - [Duda](https://docs.cookiechimp.com/docs/installation/duda.md): Add a GDPR & CCPA compliant cookie consent banner to your Duda site with CookieChimp. Install via Site-Wide Code in seconds. - [Framer](https://docs.cookiechimp.com/docs/installation/framer.md): Add a GDPR & CCPA compliant cookie consent banner to your Framer site with CookieChimp. Step-by-step custom code installation for Framer projects. - [Ghost](https://docs.cookiechimp.com/docs/installation/ghost.md): Install a GDPR-compliant cookie consent banner on your Ghost blog or publication with CookieChimp. Works with Ghost(Pro) and self-hosted Ghost via Code Injection. - [Google Tag Manager](https://docs.cookiechimp.com/docs/installation/google-tag-manager.md): Set up a consent banner with Google Tag Manager and Google Consent Mode. - [Hostinger Website Builder](https://docs.cookiechimp.com/docs/installation/hostinger.md): Add a GDPR & CCPA compliant cookie consent banner to your Hostinger Website Builder site with CookieChimp. Install via Integrations & custom code. - [HTML](https://docs.cookiechimp.com/docs/installation/html.md): Install a consent banner on any plain HTML website — no framework or build step required. - [Installation](https://docs.cookiechimp.com/docs/installation/installation.md): Add CookieChimp to your website in under 5 minutes. - [Next.js](https://docs.cookiechimp.com/docs/installation/nextjs.md): Install a consent banner in a Next.js application with the App Router or Pages Router. - [Nuxt](https://docs.cookiechimp.com/docs/installation/nuxt.md): Install a consent banner in a Nuxt 3 application. - [React](https://docs.cookiechimp.com/docs/installation/react.md): Install a consent banner in a React app built with Vite or Create React App. - [Remix](https://docs.cookiechimp.com/docs/installation/remix.md): Install a consent banner in a Remix application. - [Shopify](https://docs.cookiechimp.com/docs/installation/shopify.md): Install a consent banner on your Shopify store. - [JS & Single Page Apps](https://docs.cookiechimp.com/docs/installation/single-page-applications.md): Install a consent banner in JavaScript-powered SPAs like Astro, Vue, React Router, SvelteKit, and more. - [Squarespace](https://docs.cookiechimp.com/docs/installation/squarespace.md): Add a GDPR & CCPA compliant cookie consent banner to your Squarespace site with CookieChimp. Install via Header Code Injection. - [SvelteKit](https://docs.cookiechimp.com/docs/installation/sveltekit.md): Install a consent banner in a SvelteKit application. - [Webflow](https://docs.cookiechimp.com/docs/installation/webflow.md): Add a GDPR & CCPA compliant cookie consent banner to your Webflow site with CookieChimp. Step-by-step Custom Code installation in Project Settings. - [Weebly](https://docs.cookiechimp.com/docs/installation/weebly.md): Add a GDPR & CCPA compliant cookie consent banner to your Weebly site with CookieChimp. Install via Header Code in Weebly's SEO settings. - [Wix](https://docs.cookiechimp.com/docs/installation/wix.md): Add a GDPR & CCPA compliant cookie consent banner to your Wix site with CookieChimp. Install via Wix Custom Code in a few clicks. - [WordPress](https://docs.cookiechimp.com/docs/installation/wordpress.md): Install a consent banner on your WordPress site. - [Global Privacy Control](https://docs.cookiechimp.com/docs/integrations/global-privacy-control.md): Automatically honor the GPC browser signal so opt-out users skip the banner. - [Google Consent Mode](https://docs.cookiechimp.com/docs/integrations/google-consent-mode.md): Send consent state to Google's tags for Analytics, Ads, and other Google services. - [Meta Consent API](https://docs.cookiechimp.com/docs/integrations/meta-consent-api.md): Send consent state to the Meta (Facebook/Instagram) Pixel. - [Microsoft Clarity Consent Mode](https://docs.cookiechimp.com/docs/integrations/microsoft-clarity.md): Allow or block Microsoft Clarity session recordings and heatmaps based on consent. - [Microsoft UET Consent Mode](https://docs.cookiechimp.com/docs/integrations/microsoft-uet.md): Pass consent to Microsoft's Universal Event Tracking tag for Microsoft Advertising. - [Integrations Overview](https://docs.cookiechimp.com/docs/integrations/overview.md): Connect CookieChimp with third-party services so they respect user consent. - [Shopify Customer Privacy API](https://docs.cookiechimp.com/docs/integrations/shopify-privacy-api.md): Sync consent with Shopify's storefront so first-party pixels and Shop Pay respect the visitor's choices. - [WordPress Consent API](https://docs.cookiechimp.com/docs/integrations/wordpress-consent-api.md): Share consent with any WordPress plugin that supports the WP Consent API. - [Overview](https://docs.cookiechimp.com/docs/overview.md): Learn what a developer-first consent management platform can do. - [Why Use a CMP?](https://docs.cookiechimp.com/docs/why-use-a-cmp.md): What a consent management platform handles for you — and why building one yourself is harder than it looks. ## OpenAPI Specs - [openapi](https://docs.cookiechimp.com/docs/openapi.yaml) ## Optional - [Quick Start](https://cookiechimp.com/install)