members.grant

What it does

Grant explicit scoped membership to a known principal. Member permissions are stored as complete statements; no preset is expanded during authorization. Requires a signed-in account session; OAuth applications cannot change membership.

Before you send it

Requires a signed-in human in the first-party browser. OAuth clients cannot execute it. Effective membership, application grant and token permissions still apply. Describe members.grant through GET /v1/catalog/commands/{name} before acting.

This command does not accept source_document_id in its envelope. Any input evidence requirements remain as documented below.

These input fields name principals the platform must already know: principalId.

Inputs

Put these fields inside the envelope’s input object. The outer envelope names the command, a stable idempotency_key and effective_at; request and recovery rules explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

Required means required within its containing object; an optional parent can be omitted.

After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns commandId, replayed, the command-specific result below and emitted events with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect result and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch GET /v1/commands/{id} with commandId to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with events: [] and return a transient result and commandId without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain no_change is a separate success outcome with no persisted receipt.

Result fields

Required means required within its containing object; an optional parent can be omitted.

All commands · Operation and errors · Reusable schemas

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

Exact request schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "members.grant"
    },
    "input": {
      "type": "object",
      "properties": {
        "principalId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "description": "A principal id the platform knows, obtained from the person's sign-in; never invented."
        },
        "role": {
          "enum": [
            "owner",
            "member"
          ]
        },
        "preset": {
          "type": "object",
          "properties": {
            "name": {},
            "version": {
              "const": 1
            }
          },
          "required": [
            "name",
            "version"
          ]
        },
        "permissions": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Explicit permission statements, required for members."
        }
      },
      "required": [
        "principalId"
      ],
      "additionalProperties": false
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}

Accepted command receipt

{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object",
      "properties": {
        "principalId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "role": {
          "enum": [
            "owner",
            "member"
          ]
        }
      },
      "required": [
        "principalId",
        "role"
      ]
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}

Example request

{
  "name": "members.grant",
  "input": {
    "principalId": "prin_example_teammate",
    "role": "owner"
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "members.grant-example-0"
}