HubSpot · Schema

BatchCallsResponse

Response for batch call operations

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationSales

Properties

Name	Type	Description
status	string	The status of the batch operation
results	array	The results of the batch operation
requestedAt	string	When the batch was requested
startedAt	string	When the batch processing started
completedAt	string	When the batch processing completed
errors	array	Any errors that occurred during batch processing
links	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/engagement-calls-api-batch-calls-response-schema.json",
  "title": "BatchCallsResponse",
  "description": "Response for batch call operations",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "description": "The status of the batch operation",
      "example": "COMPLETE"
    },
    "results": {
      "type": "array",
      "description": "The results of the batch operation",
      "items": {
        "type": "object",
        "description": "Represents a call engagement in the CRM",
        "required": [
          "id",
          "properties",
          "createdAt",
          "updatedAt",
          "archived"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the call",
            "example": "512"
          },
          "properties": {
            "type": "object",
            "description": "The call properties",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "hs_call_title": "Discovery Call",
              "hs_call_body": "Discussed product requirements",
              "hs_call_duration": "1800000",
              "hs_call_direction": "OUTBOUND",
              "hs_call_disposition": "connected",
              "hs_call_status": "COMPLETED",
              "hs_timestamp": "2024-01-15T10:30:00.000Z"
            }
          },
          "propertiesWithHistory": {
            "type": "object",
            "description": "Properties with their change history",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/PropertyHistory"
              }
            },
            "example": {
              "key": "value"
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the call was created",
            "example": "2024-01-15T10:30:00.000Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the call was last updated",
            "example": "2024-01-15T11:00:00.000Z"
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the call is archived",
            "example": false
          },
          "archivedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the call was archived (if archived)",
            "example": "2025-03-15T14:30:00Z"
          }
        }
      },
      "example": [
        {
          "id": "512",
          "properties": {
            "hs_call_title": "Discovery Call",
            "hs_call_body": "Discussed product requirements",
            "hs_call_duration": "1800000",
            "hs_call_direction": "OUTBOUND",
            "hs_call_disposition": "connected",
            "hs_call_status": "COMPLETED",
            "hs_timestamp": "2024-01-15T10:30:00.000Z"
          },
          "propertiesWithHistory": {
            "key": "value"
          },
          "createdAt": "2024-01-15T10:30:00.000Z",
          "updatedAt": "2024-01-15T11:00:00.000Z",
          "archived": false,
          "archivedAt": "2025-03-15T14:30:00Z"
        }
      ]
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the batch was requested",
      "example": "2025-03-15T14:30:00Z"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the batch processing started",
      "example": "2024-01-15T10:30:00.000Z"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the batch processing completed",
      "example": "2024-01-15T10:30:05.000Z"
    },
    "errors": {
      "type": "array",
      "description": "Any errors that occurred during batch processing",
      "items": {
        "type": "object",
        "description": "Error information for a batch operation item",
        "properties": {
          "status": {
            "type": "string",
            "description": "The error status",
            "example": "error"
          },
          "category": {
            "type": "string",
            "description": "The error category",
            "example": "VALIDATION_ERROR"
          },
          "message": {
            "type": "string",
            "description": "The error message",
            "example": "Property value is invalid"
          },
          "context": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": {
              "key": "value"
            }
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErrorDetail"
            },
            "example": [
              {
                "message": "This is an example description.",
                "code": "example-value",
                "in": "example-value",
                "subCategory": "standard",
                "context": {
                  "key": "value"
                }
              }
            ]
          }
        }
      },
      "example": [
        {
          "status": "error",
          "category": "VALIDATION_ERROR",
          "message": "Property value is invalid",
          "context": {
            "key": "value"
          },
          "errors": [
            {}
          ]
        }
      ]
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "status",
    "results",
    "startedAt",
    "completedAt"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/engagement-calls-api-batch-calls-response"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.