# doomConsentPurpose

mutation · in the family [Consent purpose](/reference/consent-purpose/)

## What it does

Permanently retire a consent purpose — one named thing customers can allow or refuse (marketing email, data use).

Doom (terminal) a ConsentPurpose: active|inactive → doomed. -GATED by the everReferenced write-once stamp — a purpose EVER named by a consent decision refuses CONFLICT/REFERENCED (detail names the ConsentRecord TYPE, id-less — the cardinality forbids listing walks; historical proof blocks forever, pre-purge; deactivate is the retire lane). A VIRGIN purpose dooms freely; its code marker RELEASES with the flip (reissuable — the org-code class). Requires the current revision (OCC) + the unrestricted capability.

## Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

## Who may call it

Capability area: **Privacy and compliance** — Tax and fiscal configuration, certificates and privacy requests.

- Owner
- System Administrator
- An API key whose scope allows `api:doomConsentPurpose`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | yes | The id of the record. |
| `revision` | [ID](/types/#scalars) `ID!` | yes | The revision id you read on the record; the change is refused if an edit landed in the meantime. |
| `reason` | [String](/types/#scalars) | no | No further notes. |

## Returns

[ConsentPurpose](/types/ConsentPurpose/) `ConsentPurpose!` — A ConsentPurpose — the merchant-definable registry of WHAT consent can be requested for (group-parented master; GROUP-WIDE scope — per-org consent is the lock's flagged-not-now). Canned + custom AS THE ROLE MODEL WORKS: the 6 canned baselines are CODE-VIRTUAL versioned templates (cannedConsentPurposes lists them; copyCannedConsentPurpose materializes an ORDINARY EDITABLE group row — bootstrap materializes ZERO). Per-channel marketing granularity = DISTINCT purposes (GDPR consent is specific, never bundled). consentModel ∈ {opt_in, opt_out} — opt_in: an ABSENT record ⇒ DENIED (GDPR) · opt_out: an ABSENT record ⇒ ALLOWED until withdrawn (CCPA Do-Not-Sell) — ⚠ IMMUTABLE AFTER BIRTH. The code is the mutable machine handle — UNIQUE among NON-DOOMED per group via the consentPurposeCode UNIQ marker (the organizationCode class: edit = release/reserve swap; doom RELEASES \[reissuable]; inactive HOLDS; a collision refuses CONFLICT/IDENTITY_TAKEN). DOOM is -gated by the everReferenced write-once stamp; DEACTIVATE is UNGATED. NOT searchable (config, not a book); NO description field (captions + decorations do display duty).

## Example request

```graphql
mutation ExampleDoomConsentPurpose($id: ID!, $revision: ID!, $reason: String) {
  doomConsentPurpose(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    code
    consentModel
    templateKey
    templateVersion
    everReferenced
  }
}
```

Variables:

```json
{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

## Example response

```json
{
  "data": {
    "doomConsentPurpose": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PP-EXMP-0000-000F",
      "type": "ConsentPurpose",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "code": "BJ-001",
      "consentModel": "<consent model>",
      "templateKey": "<template key>",
      "templateVersion": 1,
      "everReferenced": true
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))