HubSpot · Schema

BatchResponseTask

BatchResponseTask schema from HubSpot Engagement Tasks API

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
status string
results array
completedAt string
View JSON Schema on GitHub

JSON Schema

engagement-tasks-api-batch-response-task-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/engagement-tasks-api-batch-response-task-schema.json",
  "title": "BatchResponseTask",
  "description": "BatchResponseTask schema from HubSpot Engagement Tasks API",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "example": "active"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A HubSpot task engagement record.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the task.",
            "example": "500123"
          },
          "properties": {
            "type": "object",
            "description": "The task's properties as key-value pairs.",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "key": "value"
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          },
          "archived": {
            "type": "boolean",
            "example": true
          },
          "associations": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/CollectionResponseAssociation"
            },
            "example": {
              "key": "value"
            }
          }
        }
      },
      "example": [
        {
          "id": "500123",
          "properties": {
            "key": "value"
          },
          "createdAt": "2025-03-15T14:30:00Z",
          "updatedAt": "2025-03-15T14:30:00Z",
          "archived": true,
          "associations": {
            "key": "value"
          }
        }
      ]
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}