# updateVariantComponent

mutation · in the family [Variant component](/reference/variant-component/)

## What it does

Edit a kit recipe line — which component (and how many) goes into a kit variant — change its details.

Edit a VariantComponent's mutable attributes. Requires the unrestricted capability + the record's CURRENT revision.

## Careful

Edits take effect immediately and write a new revision; the old revision stays in history.

## 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:updateVariantComponent`

## 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. |
| `input` | [EditVariantComponentInput](/types/EditVariantComponentInput/) `EditVariantComponentInput!` | yes | No further notes. |

## Returns

[VariantComponent](/types/VariantComponent/) `VariantComponent!` — A variant component — ONE bill-of-materials edge: quantity units of a COMPONENT Variant inside a kit/bundle HOST Variant. Parent = the HOST Variant (components die with it). The coupling matrix gates creation: a kit assembles simple component variants ONLY; a bundle groups simple | service | kit (never bundles — acyclic BY TYPE). Composition (host x component) is unique (a live duplicate is CONFLICT/IDENTITY_TAKEN naming the holder); REMOVE = doom (TWO_STATE — history preserved); re-adding mints a NEW record via marker takeover. BUILD/BREAK stock semantics + assembly-mode policy evaluation are consumers of this stored shape.

## Example request

```graphql
mutation ExampleUpdateVariantComponent($id: ID!, $revision: ID!, $input: EditVariantComponentInput!) {
  updateVariantComponent(id: $id, revision: $revision, input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    componentVariantId
    quantity
  }
}
```

Variables:

```json
{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "input": {
    "caption": "Blue jeans"
  }
}
```

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

## Example response

```json
{
  "data": {
    "updateVariantComponent": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "VC-EXMP-0000-000F",
      "type": "VariantComponent",
      "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",
      "componentVariantId": "01900000-0000-7000-8000-02c180840000",
      "quantity": 1
    }
  },
  "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/))

## Dry run

Add `dryRun: true` to the request envelope (`extensions.at`) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries `dryRun: true`, so a rehearsed record is never mistaken for a saved one.