HubSpot · Schema

BatchInput

Input for batch update operations

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
inputs array Array of items to process
View JSON Schema on GitHub

JSON Schema

hubspot-authors-batch-input-schema.json Raw ↑
{
  "type": "object",
  "description": "Input for batch update operations",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "Array of items to process",
      "example": [
        {
          "id": "500123",
          "properties": {}
        }
      ],
      "items": {
        "type": "object",
        "description": "Single item in a batch update operation",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the author to update",
            "example": "500123"
          },
          "properties": {
            "type": "object",
            "description": "Input data for creating or updating a blog author",
            "properties": {
              "name": {
                "type": "string",
                "description": "Full display name of the author",
                "example": "Example Record"
              },
              "slug": {
                "type": "string",
                "description": "URL-friendly identifier for the author",
                "example": "example-value"
              },
              "email": {
                "type": "string",
                "description": "Author's email address",
                "format": "email",
                "example": "[email protected]"
              },
              "bio": {
                "type": "string",
                "description": "Author biography or description",
                "example": "example-value"
              },
              "website": {
                "type": "string",
                "description": "Author's personal website URL",
                "format": "uri",
                "example": "https://app.hubspot.com/contacts/12345"
              },
              "twitter": {
                "type": "string",
                "description": "Author's Twitter/X handle",
                "example": "example-value"
              },
              "facebook": {
                "type": "string",
                "description": "Author's Facebook profile URL",
                "example": "example-value"
              },
              "linkedin": {
                "type": "string",
                "description": "Author's LinkedIn profile URL",
                "example": "https://app.hubspot.com/contacts/12345"
              },
              "avatar": {
                "type": "string",
                "description": "URL to the author's avatar image",
                "format": "uri",
                "example": "https://app.hubspot.com/contacts/12345"
              }
            },
            "required": [
              "name"
            ]
          }
        },
        "required": [
          "id"
        ]
      }
    }
  },
  "required": [
    "inputs"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchInput"
}