{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ometria/json-schema/ometria-field-forget-request-schema.json",
  "title": "FieldForgetRequest",
  "description": "Describes a field forget request and its status",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ometria-field-forget-email-phone-erasure-api-openapi.yml#/components/schemas/FieldForgetRequest",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The request ID"
    },
    "profile_hash": {
      "type": "string",
      "description": "The profile hash of the profile the request was filed for (eg 27f4-f0b281-00003039)."
    },
    "status": {
      "type": "string",
      "description": "Current state of the request. `pending`: accepted and queued. `in_progress`: being processed. Terminal states: `completed` (the requested fields were erased), `aborted_sole_identifier` (refused and nothing changed, because erasing the fields would have left the profile with no other identifier Ometria can match on), `not_found` (the profile did not exist when processed), `failed` (an error occurred; resubmit to retry).",
      "enum": [
        "pending",
        "in_progress",
        "completed",
        "aborted_sole_identifier",
        "failed",
        "not_found"
      ]
    },
    "fields": {
      "type": "array",
      "description": "The fields requested, sorted alphabetically and deduplicated.",
      "items": {
        "type": "string",
        "description": "A field that can be forgotten. This list is the set supported by the service and is kept in sync via the service's own spec test.",
        "enum": [
          "email",
          "phone"
        ]
      }
    },
    "source": {
      "type": "object",
      "description": "Where the request originated.",
      "properties": {
        "origin": {
          "type": "string",
          "description": "`api` for requests filed through this API, `app` for requests filed from the Ometria app.",
          "enum": [
            "app",
            "api"
          ]
        },
        "api_request_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Identifies the `POST /field-forget` call that filed this request. If you sent an `X-Request-ID` header on that call, this is its value, so you can correlate the request with your own logs; otherwise Ometria generates one. `null` for requests filed from the Ometria app."
        }
      }
    },
    "timestamp_created": {
      "type": "string",
      "description": "Date and time of request being filed. Following ISO 8601 dateTime format with timezone offset _YYYY-MM-DDThh:mm:ss+Z_.",
      "format": "date-time"
    },
    "timestamp_completed": {
      "type": [
        "string",
        "null"
      ],
      "description": "Date and time of request reaching a terminal status. Following ISO 8601 dateTime format with timezone offset _YYYY-MM-DDThh:mm:ss+Z_. `null` while the request is `pending` or `in_progress`.",
      "format": "date-time"
    }
  }
}