HubSpot · Schema

BatchResponseEmailEngagement

BatchResponseEmailEngagement schema from HubSpot Engagement Emails API

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

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

JSON Schema

engagement-emails-api-batch-response-email-engagement-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-emails-api-batch-response-email-engagement-schema.json",
  "title": "BatchResponseEmailEngagement",
  "description": "BatchResponseEmailEngagement schema from HubSpot Engagement Emails API",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "example": "active"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A HubSpot email engagement record.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the email engagement.",
            "example": "500123"
          },
          "properties": {
            "type": "object",
            "description": "The email engagement'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"
    }
  }
}