{ "type": "object", "description": "Response for batch call operations", "properties": { "status": { "type": "string", "description": "The status of the batch operation", "example": "COMPLETE", "enum": [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ] }, "results": { "type": "array", "description": "The results of the batch operation", "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" } ], "items": { "type": "object", "description": "Represents a call engagement in the CRM", "properties": { "id": { "type": "string", "description": "The unique identifier for the call", "example": "512" }, "properties": { "type": "object", "description": "The call properties", "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", "example": { "key": "value" } }, "createdAt": { "type": "string", "description": "When the call was created", "format": "date-time", "example": "2024-01-15T10:30:00.000Z" }, "updatedAt": { "type": "string", "description": "When the call was last updated", "format": "date-time", "example": "2024-01-15T11:00:00.000Z" }, "archived": { "type": "boolean", "description": "Whether the call is archived", "example": false }, "archivedAt": { "type": "string", "description": "When the call was archived (if archived)", "format": "date-time", "example": "2025-03-15T14:30:00Z" } }, "required": [ "id", "properties", "createdAt", "updatedAt", "archived" ] } }, "requestedAt": { "type": "string", "description": "When the batch was requested", "format": "date-time", "example": "2025-03-15T14:30:00Z" }, "startedAt": { "type": "string", "description": "When the batch processing started", "format": "date-time", "example": "2024-01-15T10:30:00.000Z" }, "completedAt": { "type": "string", "description": "When the batch processing completed", "format": "date-time", "example": "2024-01-15T10:30:05.000Z" }, "errors": { "type": "array", "description": "Any errors that occurred during batch processing", "example": [ { "status": "error", "category": "VALIDATION_ERROR", "message": "Property value is invalid", "context": { "key": "value" }, "errors": [ {} ] } ], "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", "example": { "key": "value" } }, "errors": { "type": "array", "example": [ { "message": "This is an example description.", "code": "example-value", "in": "example-value", "subCategory": "standard", "context": { "key": "value" } } ], "items": { "type": "object", "description": "Detailed error information", "properties": { "message": { "type": "string", "description": "Error message", "example": "This is an example description." }, "code": { "type": "string", "description": "Error code", "example": "example-value" }, "in": { "type": "string", "description": "Field where error occurred", "example": "example-value" }, "subCategory": { "type": "string", "description": "Error subcategory", "example": "standard" }, "context": { "type": "object", "example": { "key": "value" } } }, "required": [ "message" ] } } } } }, "links": { "type": "object", "example": { "key": "value" } } }, "required": [ "status", "results", "startedAt", "completedAt" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "BatchCallsResponse" }