HubSpot · JSON Structure

Crm Contacts Api Batch Response Contact Structure

Results from a batch operation on contacts.

Type: object Properties: 3
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

BatchResponseContact is a JSON Structure definition published by HubSpot, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status results completedAt

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-contacts-api-batch-response-contact-structure.json",
  "name": "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": "datetime",
            "description": "The date and time the contact was created.",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "datetime",
            "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": "datetime",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}