HubSpot · JSON Structure

Commerce Payments Api Batch Update Input Item Structure

A single input item for batch update

Type: object Properties: 3 Required: 2
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

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

Properties

id properties idProperty

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/commerce-payments-api-batch-update-input-item-structure.json",
  "name": "BatchUpdateInputItem",
  "description": "A single input item for batch update",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the payment to update",
      "example": "500123"
    },
    "properties": {
      "type": "object",
      "description": "The properties to update",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value"
      }
    },
    "idProperty": {
      "type": "string",
      "description": "The property to use as the identifier",
      "example": "500123"
    }
  },
  "required": [
    "id",
    "properties"
  ]
}