HubSpot · JSON Structure

Authors Api Batch Input Item Structure

Single item in a batch update operation

Type: object Properties: 2 Required: 1

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

BatchInputItem is a JSON Structure definition published by HubSpot, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id properties

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/authors-api-batch-input-item-structure.json",
  "name": "BatchInputItem",
  "description": "Single item in a batch update operation",
  "type": "object",
  "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",
          "example": "jsmith@example.com"
        },
        "bio": {
          "type": "string",
          "description": "Author biography or description",
          "example": "example-value"
        },
        "website": {
          "type": "uri",
          "description": "Author's personal website URL",
          "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": "uri",
          "description": "URL to the author's avatar image",
          "example": "https://app.hubspot.com/contacts/12345"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "id"
  ]
}