AlmondTill/G3N API

On this page

deactivateContact

mutation · in the family Contact

What it does

Deactivate a contact — a person or address book entry — it stops being usable but keeps its history and can be reactivated.

Deactivate a Contact 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: Purchasing — Purchase orders, returns to vendors, vendor invoices and supplier records.

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

Contact Contact! — A contact — the UNIFIED, REUSABLE contact-info master: one group-scoped record holding an optional PERSON block and/or an optional INLINE address block (at-least-one-of — an empty contact is refused at the boundary), attached to hosts via role-tagged ContactAssignments. Group-scoped like a Brand (parent = the org group). Carries EXTERNAL-party + functional addresses ONLY — the PhysicalFacilityLocation stays the SOLE physical-address holder for OUR facilities (the PFL fence). Deactivate AND doom are BOTH blocked by live (active) assignments.

Example request

mutation ExampleDeactivateContact($id: ID!, $revision: ID!, $reason: String) {
  deactivateContact(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    notes
  }
}

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": {
    "deactivateContact": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "CO-EXMP-0000-000F",
      "type": "Contact",
      "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",
      "notes": "Restock before the weekend."
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer