HubSpot · Schema

BatchResponseContact

Results from a batch operation on contacts.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
status string The status of the batch operation.
results array
completedAt string
View JSON Schema on GitHub

JSON Schema

crm-contacts-api-batch-response-contact-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/crm-contacts-api-batch-response-contact-schema.json",
  "title": "BatchResponseContact",
  "description": "Results from a batch operation on contacts.",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the batch operation.",
      "example": "active"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A HubSpot contact record.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the contact.",
            "example": "500123"
          },
          "properties": {
            "type": "object",
            "description": "The contact's properties as key-value pairs.",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "key": "value"
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the contact was created.",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time the contact was last updated.",
            "example": "2025-03-15T14:30:00Z"
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the contact has been archived.",
            "example": true
          },
          "associations": {
            "type": "object",
            "description": "The contact's associations with other CRM objects.",
            "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"
    }
  }
}