AlmondTill/G3N API

On this page

deactivateTeam

mutation · in the family Team

What it does

Deactivate a team — a working group of staff — it stops being usable but keeps its history and can be reactivated.

active → inactive (retire the team from active use — reversible; its TASKBOOK#TEAM history stays readable).

Who may call it

Capability area: Places and layout — How your organizations and facilities are arranged day to day — facilities, zones and bins, teams and labels.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

Team Team! — A Team — a named group Users inside ONE org group (org-group-parented master — the Role/Brand class). Built DOMAIN-NEUTRAL by ruling: Tasks v1 is merely the FIRST consumer (task teamIds + the TASKBOOK#TEAM inbox lane, teamTasks); the CS routing/queues build consumes it later WITHOUT reshaping (the CsCase assignedTo doc's own deferral resolves construct-side HERE). memberUserIds is a BOUNDED distinct set (≤100; a larger org models sub-teams, not a mega-list; every member in-tenant + ACTIVE at set); leadUserId MUST be a member (strict). FSM: active(i) ⇄ inactive → doomed. SEARCHABLE by caption (the law — a team book is name-found; ⚠ the WIRE enum joins at the deploy leg). The identity event domain (at.identity.team.* — teams group identity-domain principals).

Example request

mutation ExampleDeactivateTeam($id: ID!, $revision: ID!, $reason: String) {
  deactivateTeam(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    memberUserIds
    leadUserId
  }
}

Variables:

{
  "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

{
  "data": {
    "deactivateTeam": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "TM-EXMP-0000-000F",
      "type": "Team",
      "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",
      "memberUserIds": [
        "01900000-0000-7000-8000-77bba28a0000"
      ],
      "leadUserId": "01900000-0000-7000-8000-3e7bb9b10000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in