EmailListImport

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/politicalcomms-com/json-schema/politicalcomms-com-email-list-import-schema.json",
  "title": "EmailListImport",
  "description": "One import of a caller-hosted CSV into an email list.",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/politicalcomms-com-openapi.json#/components/schemas/EmailListImport",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "status": {
      "type": "string",
      "description": "Import lifecycle state. Terminal states are `completed` and `failed`."
    },
    "email_list_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "file_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Derived from the last path segment of `source_url`."
    },
    "file_size": {
      "type": "integer",
      "description": "Bytes fetched."
    },
    "headers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The CSV's header row as read. Echoed back so a caller that omitted `mapping` can see what the recognizer worked from."
    },
    "mapping": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "CSV header to contact field. The mapping actually used, whether you sent it or the recognizer produced it."
    },
    "recognized_provider": {
      "type": [
        "string",
        "null"
      ],
      "description": "The ESP whose export format was recognized, when one was."
    },
    "summary": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "screened": {
          "type": "integer",
          "description": "Addresses currently held out of sending by send-time screening. They are imported but held back, and are checked again after the 90-day hold."
        }
      },
      "additionalProperties": true,
      "description": "Row counts once the import finishes, including `screened`."
    },
    "error_message": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "started_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "completed_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "status"
  ],
  "additionalProperties": true
}