# deactivateSizeRun

mutation · in the family [Size run](/reference/size-run/)

## What it does

Deactivate a size run — the ratio a buyer spreads a quantity over one option dimension (S-M-L-XL 1-2-2-1), kept once and reused by every style that names it — it stops being usable but keeps its history and can be reactivated.

Deactivate a SizeRun 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.

## Who may call it

Capability area: **Catalog editing** — Changing what you sell — the details of styles, products, variants and their identifiers.

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

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

[SizeRun](/types/SizeRun/) `SizeRun!` — A size run — a RATIO over ONE option dimension (S-M-L-XL 1-2-2-1; a colour run 2 black: 1 white is equally real — any OptionGroup type may carry a run) a buyer fills a matrix with: kept ONCE and reused on every Style that names it (Style.sizeRunId — its group must be in the scheme) or by the dimension itself (OptionGroup.defaultSizeRunId — the org default lives on the dimension); resolution = the style pick, then the group default, then none (the matrix axes carry the resolved id). optionGroupId is IMMUTABLE at birth (a different dimension is a DIFFERENT run: doom + create — the PurchasePack unitsPerPack stance). entries = 1..256 { optionValueId, share } rows — DISTINCT values OF THAT GROUP, every share an integer 0..10000, the shares summing to at least 1, stored in the CALLER order = the display order (a 0-share value rides the run but never receives a unit). sizeRunFill spreads a total over the ratio by the fill rule (largest remainder, ties to the earlier entry, the quantities summing to the total exactly). Doom is blocked while a non-doomed Style or OptionGroup names the run (CONFLICT/REFERENCED naming the holders); deactivate is free. Group-parented (parentId === rootId); sysId SZ-….

## Example request

```graphql
mutation ExampleDeactivateSizeRun($id: ID!, $revision: ID!, $reason: String) {
  deactivateSizeRun(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    optionGroupId
    code
  }
}
```

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": {
    "deactivateSizeRun": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SZ-EXMP-0000-000F",
      "type": "SizeRun",
      "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",
      "optionGroupId": "01900000-0000-7000-8000-14f0cf6a0000",
      "code": "BJ-001"
    }
  },
  "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/))