# deactivateSegment

mutation · in the family [Segment](/reference/segment/)

## What it does

Stage a segment — it stays editable but marked inactive.

Deactivate a Segment by id; requires the unrestricted capability + the record's CURRENT revision. Deny-by-default + the referential_integrity / authority / occ guards. The optional reason rides the transition events.

## What happens

Reversible.

## Who may call it

Capability area: **Pricing** — Prices, price schedules, promotions, coupons and the money rules of selling.

- Owner
- Manager
- An API key whose scope allows `api:deactivateSegment`

## 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

[Segment](/types/Segment/) `Segment!` — A Segment: a merchant-authored CONSUMER grouping for marketing. segmentType is IMMUTABLE at birth — static (explicit membership: batched adds/removes of ≤48 consumers per call, the one-transaction law; the pair key dedupes structurally) or dynamic (membership DERIVED from the stored predicate — the member ops refuse; edit the predicate/exclusions and call refreshSegment to re-materialize; evaluatedAt shows the staleness honestly, refreshProblem words a queued refresh that could not complete, and a scheduled sweep re-refreshes stale ACTIVE dynamics ~daily). memberCount meters live membership (bounded ≤100000 — the add/refresh refuses past it naming the figure). MARKETING-ONLY-OVER-CONSENTED is the CONSUMING lane's law when campaigns/exports arrive — the definition stores membership only. NOT searchable (a membership register); inactive = staging (membership edits stay legal while building).

## Example request

```graphql
mutation ExampleDeactivateSegment($id: ID!, $revision: ID!, $reason: String) {
  deactivateSegment(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    segmentType
    memberCount
    excludedConsumerIds
    evaluatedAt
    refreshProblem
  }
}
```

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": {
    "deactivateSegment": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SE-EXMP-0000-000F",
      "type": "Segment",
      "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",
      "segmentType": "static",
      "memberCount": 1,
      "excludedConsumerIds": [
        "01900000-0000-7000-8000-2fe46bb30000"
      ],
      "evaluatedAt": "2027-01-31T00:00:00.000Z",
      "refreshProblem": "<refresh problem>"
    }
  },
  "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/))