HubSpot · JSON Structure

Engagement Calls Api Call Create Request Structure

Request body for creating a call

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

CallCreateRequest 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

properties associations

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/engagement-calls-api-call-create-request-structure.json",
  "name": "CallCreateRequest",
  "description": "Request body for creating a call",
  "type": "object",
  "properties": {
    "properties": {
      "type": "object",
      "description": "The call properties to set",
      "additionalProperties": {
        "type": "string"
      },
      "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",
      "items": {
        "type": "object",
        "description": "Association to create with another object",
        "required": [
          "to",
          "types"
        ],
        "properties": {
          "to": {
            "type": "object",
            "required": [
              "id"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the object to associate with",
                "example": "101"
              }
            },
            "example": {
              "id": "101"
            }
          },
          "types": {
            "type": "array",
            "description": "The association types",
            "items": {
              "$ref": "#/components/schemas/AssociationType"
            },
            "example": [
              {
                "associationCategory": "HUBSPOT_DEFINED",
                "associationTypeId": 194
              }
            ]
          }
        }
      },
      "example": [
        {
          "to": {
            "id": {}
          },
          "types": [
            {}
          ]
        }
      ]
    }
  },
  "required": [
    "properties"
  ]
}