# updateConsumer

mutation · in the family [Consumer](/reference/consumer/)

## What it does

Edit a consumer profile — the shopper identity used by portals — change its details.

Edit a Consumer'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: **Selling** — Ringing sales, serving customers and issuing invoices.

- Owner
- Manager
- Associate Manager
- Sales Associate
- Cashier
- An API key whose scope allows `api:updateConsumer`

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

## Returns

[Consumer](/types/Consumer/) `Consumer!` — A Consumer — the B2C SHOPPER identity: WHO shops, as a per-merchant-group person (parentId === rootId — NOT a global identity; federated cross-merchant identity is the lock's flagged-not-now). B2C-SIMPLE INLINE: the NORMALIZED login email + displayName + bounded phones + the inline address book (≤16; shipping/billing roles + at most ONE default per side). the identity-marker rule: the (group × normalized email) UNIQ marker AMONG LIVE HOLDERS IS the login index — a live/suspended holder refuses CONFLICT/IDENTITY_TAKEN; ⚠ on erase (doom) the identifiers BURN within the group. FSM = the identity-family roster: active ⇄ suspended (the merchant abuse/fraud hold: punitive, ≠ the operational admin-pause; sessions go INERT via the live-status gate, reactivation restores) → doomed via erase (the DE-IDENTIFICATION terminal — PII scrub machinery lands; v1 the marker burns). Credentials NEVER ride this record; self-service rides the CONSUMER SESSION channel (consumerRegister/consumerLogin + the CONSUMER_SESSION_OPERATIONS roster); staff manage via THIS face. SEARCHABLE (the customer-book law). priceGroupId = the binding — the SUPERSEDE carrier: a consumer-named order resolves eligibility HERE, present-or-absent, NO member fall-through.

## Example request

```graphql
mutation ExampleUpdateConsumer($id: ID!, $revision: ID!, $input: EditConsumerInput!) {
  updateConsumer(id: $id, revision: $revision, input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    email
    displayName
    phones
    priceGroupId
    tagIds
    locale
    displayCurrency
    dateOfBirth
    commsFrequency
    commsFormat
    commsTopics
    interests
    preferredLogicalFacilityId
  }
}
```

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": {
    "updateConsumer": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "CN-EXMP-0000-000F",
      "type": "Consumer",
      "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",
      "email": "<the person’s email address>",
      "displayName": "Blue jeans",
      "phones": [
        "<phones>"
      ],
      "priceGroupId": "01900000-0000-7000-8000-c7ffbf680000",
      "tagIds": [
        "01900000-0000-7000-8000-decd62770000"
      ],
      "locale": "en-CA",
      "displayCurrency": "<display currency>",
      "dateOfBirth": "<date of birth>",
      "commsFrequency": "<comms frequency>",
      "commsFormat": "<comms format>",
      "commsTopics": [
        "<comms topics>"
      ],
      "interests": [
        "<interests>"
      ],
      "preferredLogicalFacilityId": "01900000-0000-7000-8000-23734f810000"
    }
  },
  "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.

## Used in

- [Add a shopper and record their consent](/use-cases/add-a-shopper/)