Consent purpose
The ConsentPurpose family — 7 operations.
A consent purpose is one thing you may ask shoppers for permission to do — marketing email, marketing texts, analytics, personalization, sharing data — defined once for your whole group, one purpose per channel so consent stays specific. Its consent model decides what silence means: opt-in treats a shopper with no decision as a no; opt-out treats them as a yes until they withdraw. The model is fixed at birth, because flipping it would silently rewrite every undecided shopper’s answer — a regime change is a new purpose. The code is the machine handle, unique among your live purposes. Create purposes here and record a named shopper’s grant or withdrawal from the record; deactivating retires a purpose and every check then answers no over it, while a purpose any decision has ever named cannot be retired — the proof outlives it.
Operations
| Operation | Kind | What it does |
|---|---|---|
| consentPurpose | query | Look up one record — a consent purpose — one named thing customers can allow or refuse (marketing email, data use). |
| consentPurposes | query | The consent purpose list — each entry is a consent purpose — one named thing customers can allow or refuse (marketing email, data use). |
| createConsentPurpose | mutation | Create a new consent purpose — one named thing customers can allow or refuse (marketing email, data use) at your organization. |
| deactivateConsentPurpose | mutation | Deactivate a consent purpose — one named thing customers can allow or refuse (marketing email, data use) — it stops being usable but keeps its history and can be reactivated. |
| doomConsentPurpose | mutation | Permanently retire a consent purpose — one named thing customers can allow or refuse (marketing email, data use). |
| reactivateConsentPurpose | mutation | Reactivate a consent purpose — one named thing customers can allow or refuse (marketing email, data use) — bring a deactivated record back into use. |
| updateConsentPurpose | mutation | Edit a consent purpose — one named thing customers can allow or refuse (marketing email, data use) — change its details. |