HubSpot · JSON Structure

Hubspot Blog Posts Batch Response Structure

Response from batch operations

Type: object Properties: 6 Required: 4
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

BatchResponse is a JSON Structure definition published by HubSpot, describing 6 properties, of which 4 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

status results requestedAt startedAt completedAt links

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "Response from batch operations",
  "name": "BatchResponse",
  "properties": {
    "status": {
      "type": "string",
      "description": "Current status of the batch operation",
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ]
    },
    "results": {
      "type": "array",
      "description": "Successfully processed posts",
      "items": {
        "type": "object",
        "description": "Represents a blog post with all content and metadata",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the blog post"
          },
          "name": {
            "type": "string",
            "description": "Internal name of the blog post"
          },
          "slug": {
            "type": "string",
            "description": "URL slug for the blog post"
          },
          "htmlTitle": {
            "type": "string",
            "description": "HTML title tag content"
          },
          "postBody": {
            "type": "string",
            "description": "HTML content of the blog post body"
          },
          "postSummary": {
            "type": "string",
            "description": "Summary or excerpt of the blog post"
          },
          "blogAuthorId": {
            "type": "string",
            "description": "ID of the associated blog author"
          },
          "authorName": {
            "type": "string",
            "description": "Display name of the author"
          },
          "contentGroupId": {
            "type": "string",
            "description": "ID of the blog this post belongs to"
          },
          "campaign": {
            "type": "string",
            "description": "Campaign GUID associated with the post"
          },
          "categoryId": {
            "type": "integer",
            "description": "Category ID for the post"
          },
          "state": {
            "type": "string",
            "description": "Current state of the blog post",
            "enum": [
              "DRAFT",
              "DRAFT_AB",
              "AUTOMATED",
              "PUBLISHED",
              "SCHEDULED",
              "AUTOMATED_DRAFT"
            ]
          },
          "currentState": {
            "type": "string",
            "description": "Current state description"
          },
          "publishDate": {
            "type": "datetime",
            "description": "ISO 8601 timestamp when the post was/will be published"
          },
          "created": {
            "type": "datetime",
            "description": "ISO 8601 timestamp when the post was created"
          },
          "updated": {
            "type": "datetime",
            "description": "ISO 8601 timestamp when the post was last updated"
          },
          "archivedAt": {
            "type": "datetime",
            "description": "ISO 8601 timestamp when the post was archived"
          },
          "currentlyPublished": {
            "type": "boolean",
            "description": "Whether the post is currently published"
          },
          "domain": {
            "type": "string",
            "description": "Domain where the post is published"
          },
          "featuredImage": {
            "type": "string",
            "description": "URL of the featured image"
          },
          "featuredImageAltText": {
            "type": "string",
            "description": "Alt text for the featured image"
          },
          "metaDescription": {
            "type": "string",
            "description": "Meta description for SEO"
          },
          "headHtml": {
            "type": "string",
            "description": "Custom HTML for the head section"
          },
          "footerHtml": {
            "type": "string",
            "description": "Custom HTML for the footer section"
          },
          "language": {
            "type": "string",
            "description": "Language code of the blog post"
          },
          "translatedFromId": {
            "type": "string",
            "description": "ID of the original post this was translated from"
          },
          "tagIds": {
            "type": "array",
            "description": "Array of tag IDs associated with the post",
            "items": {
              "type": "integer"
            }
          },
          "useFeaturedImage": {
            "type": "boolean",
            "description": "Whether to display the featured image"
          },
          "url": {
            "type": "uri",
            "description": "Full URL of the published post"
          },
          "abStatus": {
            "type": "string",
            "description": "A/B test status",
            "enum": [
              "master",
              "variant"
            ]
          },
          "abTestId": {
            "type": "string",
            "description": "A/B test ID if part of a test"
          },
          "folderId": {
            "type": "string",
            "description": "ID of the folder containing the post"
          }
        },
        "required": [
          "id",
          "name",
          "created",
          "updated"
        ]
      }
    },
    "requestedAt": {
      "type": "datetime",
      "description": "ISO 8601 timestamp when the batch was requested"
    },
    "startedAt": {
      "type": "datetime",
      "description": "ISO 8601 timestamp when processing started"
    },
    "completedAt": {
      "type": "datetime",
      "description": "ISO 8601 timestamp when processing completed"
    },
    "links": {
      "type": "object",
      "description": "Related links"
    }
  },
  "required": [
    "status",
    "results",
    "startedAt",
    "completedAt"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}