AudienceUploadModel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gtm/main/json-schema/gtm-audience-upload-model-schema.json",
  "title": "AudienceUploadModel",
  "description": "Request/Response wrapper for a ZoomInfo Audience Upload",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/gtm-marketing-api-v1-api-openapi.yml#/components/schemas/AudienceUploadModel",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "allOf": [
        {
          "$ref": "#/$defs/AudienceUpload"
        }
      ],
      "description": "The primary data of the document"
    }
  },
  "$defs": {
    "AudienceUpload": {
      "type": "object",
      "required": [
        "id",
        "type",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the resource"
        },
        "type": {
          "type": "string",
          "description": "The type of the resource",
          "default": "AudienceUpload",
          "pattern": "AudienceUpload"
        },
        "attributes": {
          "allOf": [
            {
              "$ref": "#/$defs/AudienceUploadAttributes"
            }
          ],
          "description": "The attributes defining the resource"
        }
      },
      "description": "ZoomInfo Audience Upload"
    },
    "AudienceUploadAttributes": {
      "type": "object",
      "required": [
        "operationType",
        "createDate",
        "updateDate",
        "status"
      ],
      "properties": {
        "operationType": {
          "allOf": [
            {
              "$ref": "#/$defs/UploadOperationType"
            }
          ],
          "description": "Define the type of operation that this upload will perform for the audience. Add - add records to the audiences, Delete - delete records from the audience"
        },
        "createDate": {
          "type": "string",
          "format": "date-time",
          "description": "The create date of the upload",
          "readOnly": true
        },
        "updateDate": {
          "type": "string",
          "format": "date-time",
          "description": "The last update date of the upload",
          "readOnly": true
        },
        "completeDate": {
          "type": "string",
          "format": "date-time",
          "description": "The completion date of upload",
          "readOnly": true
        },
        "status": {
          "allOf": [
            {
              "$ref": "#/$defs/UploadStatus"
            }
          ],
          "description": "The status of the upload",
          "readOnly": true
        }
      },
      "description": "Attributes defining an audience member upload"
    },
    "UploadOperationType": {
      "type": "string",
      "enum": [
        "ADD",
        "DELETE"
      ],
      "description": "The type of upload",
      "x-enumDescriptions": {
        "ADD": "Adds the member upload to audience",
        "DELETE": "Removes the records from an audience"
      }
    },
    "UploadStatus": {
      "type": "string",
      "enum": [
        "IN_PROGRESS",
        "COMPLETE",
        "FAILED"
      ],
      "description": "The various status values for an audience member upload"
    }
  }
}