UpsertResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zoominfo/main/json-schema/zoominfo-upsert-response-schema.json",
  "title": "UpsertResponse",
  "description": "Response model containing the results of GTM model record upsert operations.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/zoominfo-entities-api-openapi.yml#/components/schemas/UpsertResponse",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "allOf": [
        {
          "$ref": "#/$defs/GtmResponseModel"
        }
      ],
      "description": "The primary data of the document"
    }
  },
  "$defs": {
    "GtmModelAttributes": {
      "type": "object",
      "additionalProperties": {},
      "description": "Attributes for GTM model records."
    },
    "GtmResponseModel": {
      "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": "GtmResponseModel",
          "pattern": "GtmResponseModel"
        },
        "attributes": {
          "allOf": [
            {
              "$ref": "#/$defs/UpsertResultModel"
            }
          ],
          "description": "The attributes defining the resource"
        }
      },
      "description": "GtmResponseModel"
    },
    "UpsertRecord": {
      "type": "object",
      "required": [
        "type",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the resource"
        },
        "type": {
          "type": "string",
          "description": "The type of the resource",
          "default": "UpsertRecord",
          "pattern": "UpsertRecord"
        },
        "attributes": {
          "allOf": [
            {
              "$ref": "#/$defs/GtmModelAttributes"
            }
          ],
          "description": "The attributes defining the resource"
        }
      },
      "description": "Represents a record. that will be created or updated."
    },
    "UpsertResultModel": {
      "type": "object",
      "required": [
        "recordsProcessed",
        "recordsSuccessful",
        "recordsFailed",
        "processedRecords"
      ],
      "properties": {
        "recordsProcessed": {
          "type": "number",
          "description": "recordsProcessed"
        },
        "recordsSuccessful": {
          "type": "number",
          "description": "recordsSuccessful"
        },
        "recordsFailed": {
          "type": "number",
          "description": "recordsFailed"
        },
        "processedRecords": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/UpsertRecord"
          },
          "description": "processedRecords"
        }
      },
      "description": "UpsertResultModel"
    }
  }
}