# deactivateCollaborator

mutation · in the family [Collaborator](/reference/collaborator/)

## What it does

Pause a collaborator’s access — they cannot sign in or act until reactivated.

Deactivate a Collaborator: active → inactive. The collaborator's sessions are NOT revoked — they go INERT at their next resolve (the live-status gate re-reads the Collaborator every call) and restore on reactivate within their deadlines; an outstanding invite token stays stored but acceptCollaboratorInvite refuses on a non-active collaborator. Requires the current revision (OCC) + the unrestricted capability.

## Careful

Their working sessions go dead at the next call; use with a reason.

## Who may call it

Capability area: **Identity and access** — Who can sign in and what each role allows — users, roles and their assignments.

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

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

[Collaborator](/types/Collaborator/) `Collaborator!` — A Collaborator — the strictly-scoped NON-ACCOUNT access identity: the User-adjacent NEVER-OWNER identity for EXTERNALLY-ORIGINATED parties (outside accountant/bookkeeper, agency, consultant, an integration partner's human operator, a scoped helper) granted limited access to ONE org group without being a merchant Account. Group-scoped like the Consumer (parentId === rootId — per-group NOT global; the same firm at two merchant groups = two records; federated identity is the lock's flagged-not-now). THE THREE DISTINCTIONS FROM A USER: (1) no merchant Account (its own identity + credential + session class) · (2) NO OWNERSHIP EVER (owners are Account-only structural links — there is no Collaborator state in which ownership is permitted) · (3) externally-originated (invited, not part of the merchant's principal hierarchy). Access = STRICTLY the Roles-per-org mechanism Users ride. the identity-marker rule (the Consumer burn class): the (group × normalized email) UNIQ marker IS the login index — a live/inactive holder refuses CONFLICT/IDENTITY_TAKEN; on erase (doom) the identifiers BURN within the group. Credentials NEVER ride this record: a created Collaborator is born active but CREDENTIAL-LESS — issueCollaboratorInvite mints the show-once bootstrap token, acceptCollaboratorInvite redeems it into the argon2id credential (the invite handshake is a credential-store bootstrap, NOT an FSM state — the lock's chosen lean; NO staff password-set lane EVER — recovery = re-invite rotation). Self-service rides the COLLABORATOR SESSION channel (collaboratorLogin + descriptor-gated ops); staff manage via THIS face. SEARCHABLE (the book law).

## Example request

```graphql
mutation ExampleDeactivateCollaborator($id: ID!, $revision: ID!, $reason: String) {
  deactivateCollaborator(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    email
    displayName
  }
}
```

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": {
    "deactivateCollaborator": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "CX-EXMP-0000-000F",
      "type": "Collaborator",
      "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"
    }
  },
  "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/))

## Used in

- [Bring in an outside collaborator](/use-cases/bring-in-an-outside-collaborator/)