PersonPatch

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fallax-io/json-schema/fallax-io-person-patch-schema.json",
  "title": "PersonPatch",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fallax-io-openapi.json#/components/schemas/PersonPatch",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The address this person already has. It cannot be changed here."
    },
    "firstName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional."
    },
    "lastName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional."
    },
    "department": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Reporting and breakdowns group on this."
    },
    "position": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional. Job title."
    },
    "locale": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional BCP 47 tag, e.g. `nl-BE`. Decides which translation of a lure they are sent."
    },
    "timezone": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional IANA zone, e.g. `Europe/Brussels`. Decides what local time they are sent at."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "excluded",
        "archived"
      ],
      "description": "`active`, `excluded` (stays in the directory, never simulated, not billed) or `archived` (offboarded)."
    }
  }
}