createPolicyValueRecord

mutation · in the family Policy value record

What it does

Schedule a policy value for an organization or a location — e.g. a fraud-alert threshold.

Create a PolicyValueRecord — the splice insert (the FxRate recipe); requires the unrestricted capability. The tenant is stamped server-side; the scope anchor (organizationId XOR logicalFacilityId) is tenant-scoped server-side and must be ACTIVE (CONFLICT/REF_STATE otherwise); the key must be registry-defined with the value inside its bounds; an absent startAt = effective NOW (server-stamped); an explicit startAt in the past refuses (policy history is immutable fact); a start falling STRICTLY inside the immediately-preceding window of the (parent × key) sub-schedule auto-TRIMS that predecessor (revisioned + evented, cause policy-value-trim); overlap with ANY OTHER record refuses CONFLICT/POLICY_WINDOW_OVERLAP naming the blockers; the insert transaction rides the ANCHOR construct revision-bump companion (the serializer). Template class A18_POLICY (owner/manager — sensitive config).

What happens

The value takes effect on its start instant; a window starting inside the current one ends that one early (recorded).

Careful

Policy values steer platform behavior — a wrong fraud threshold mutes or floods alerts from the moment it applies.

Who may call it

Capability area: Operating policy — The operational policies and thresholds your organization runs by.

Owner
Manager
An API key whose scope allows api:createPolicyValueRecord

Arguments

Name	Type	Required	Notes
`input`	NewPolicyValueRecordInput `NewPolicyValueRecordInput!`	yes	No further notes.

Returns

PolicyValueRecord PolicyValueRecord! — A PolicyValueRecord — ONE effective-dated value window in the tenant POLICY schedule, resolved LF → org → the registry default NEAREST-ANCESTOR-WITH-VALUE at every read. Keys are REGISTRY-DEFINED (appointment.lead_time_minutes · appointment.max_advance_days · appointment.no_show_window_minutes · appointment.overbook_allowed · fraud.threshold.cash_over_short · fraud.threshold.discount_override_abuse · fraud.threshold.dispute_chargeback · fraud.threshold.override_pattern · fraud.threshold.return_refund_abuse · fraud.threshold.void_no_sale · training.score_visibility — an unknown key refuses naming the roster; v1 = the fraud-alert thresholds, one per signal kind, default 0 on the 0..100 score scale; future keys join by registry row). Doom cancels a not-yet-effective FUTURE record only (CONFLICT/IMMUTABLE otherwise — supersede instead). The window/key/value fields are wire-IMMUTABLE (the edit surface is caption only). ⚠ The catalog ladder's zone rung is a NAMED registry growth — no v1 key legally scopes there.

Example request

mutation ExampleCreatePolicyValueRecord($input: NewPolicyValueRecordInput!) {
  createPolicyValueRecord(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    level
    key
    valueInt
    startAt
    endAt
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "key": "<key>",
    "valueInt": 1,
    "endAt": "2027-01-31T00:00:00.000Z"
  }
}

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

Example response

{
  "data": {
    "createPolicyValueRecord": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PC-EXMP-0000-000F",
      "type": "PolicyValueRecord",
      "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",
      "level": "<level>",
      "key": "<key>",
      "valueInt": 1,
      "startAt": "2027-01-31T00:00:00.000Z",
      "endAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "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)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
NOT_FOUND/* — That record could not be found. (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)
VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (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

Set a policy value — thresholds and limits