Partition Keys

The Preference Store offers partitions, which allows you to create multiple preference datasets for a single consent manager instance. In effect, it's like having several distinct Preference Stores.

Typically, partitions are used to split your preference data across development, staging, and production environments. For multi-entity organizations, partitions are also commonly used to keep separate preference datasets across distinct brands, so that an end-user may customize their preferences with each brand.

When you get started with the Preference Store, you will have one partition by default, with a partition key matching your Consent Manager bundle ID. A preference key is a unique name for the partition.

Partitions can be retrieved and updated from the Admin Dashboard, under the "Partition Key" section in the Preference Store Settings page. Click on the "Open Partition Settings" button to view and edit your partition keys.

Open Partitions Button

In the "Partitions" section of the Partition Settings modal, you can view and add new partition keys. To add a new partition key, click on the "Add a new partition" button. You can then enter a new preference key and save it. To copy an existing partition key, click on the "Copy" button next to the partition key you want to copy.

To change the default partition key, the partition your consent manager instance is set to save consent preferences to, go to the "Change your default partition" section and select the partition key you want to set as the default and click on the "Update Partitions" button.

Update Partitions in Partition Settings

Please note, you can only create new partition keys from the parent organization.