HubSpot · Schema

BatchCreateCallsRequest

Request body for batch creating calls

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
inputs array Array of calls to create
View JSON Schema on GitHub

JSON Schema

hubspot-engagement-calls-batch-create-calls-request-schema.json Raw ↑
{
  "type": "object",
  "description": "Request body for batch creating calls",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "Array of calls to create",
      "example": [
        {
          "properties": {
            "hs_call_title": "Discovery Call",
            "hs_call_body": "Discussed product requirements",
            "hs_call_duration": "1800000",
            "hs_call_direction": "OUTBOUND",
            "hs_timestamp": "2024-01-15T10:30:00.000Z"
          },
          "associations": [
            {
              "to": {
                "id": {}
              },
              "types": [
                {}
              ]
            }
          ]
        }
      ],
      "items": {
        "type": "object",
        "description": "Request body for creating a call",
        "properties": {
          "properties": {
            "type": "object",
            "description": "The call properties to set",
            "example": {
              "hs_call_title": "Discovery Call",
              "hs_call_body": "Discussed product requirements",
              "hs_call_duration": "1800000",
              "hs_call_direction": "OUTBOUND",
              "hs_timestamp": "2024-01-15T10:30:00.000Z"
            }
          },
          "associations": {
            "type": "array",
            "description": "Associations to create with other objects",
            "example": [
              {
                "to": {
                  "id": {}
                },
                "types": [
                  {}
                ]
              }
            ],
            "items": {
              "type": "object",
              "description": "Association to create with another object",
              "properties": {
                "to": {
                  "type": "object",
                  "example": {
                    "id": "101"
                  },
                  "properties": {
                    "id": {
                      "type": "object"
                    }
                  },
                  "required": [
                    "id"
                  ]
                },
                "types": {
                  "type": "array",
                  "description": "The association types",
                  "example": [
                    {
                      "associationCategory": "HUBSPOT_DEFINED",
                      "associationTypeId": 194
                    }
                  ],
                  "items": {
                    "type": "object"
                  }
                }
              },
              "required": [
                "to",
                "types"
              ]
            }
          }
        },
        "required": [
          "properties"
        ]
      }
    }
  },
  "required": [
    "inputs"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchCreateCallsRequest"
}