HubSpot · Schema

NoteCreateRequest

Request body for creating a note

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
properties object The note properties to set
associations array Associations to create with other objects
View JSON Schema on GitHub

JSON Schema

hubspot-engagement-notes-note-create-request-schema.json Raw ↑
{
  "type": "object",
  "description": "Request body for creating a note",
  "properties": {
    "properties": {
      "type": "object",
      "description": "The note properties to set",
      "example": {
        "hs_note_body": "Met with client to discuss Q1 goals. They are interested in expanding their subscription.",
        "hs_timestamp": "2024-01-15T10:30:00.000Z",
        "hubspot_owner_id": "12345"
      }
    },
    "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": "string",
                "description": "The ID of the object to associate with",
                "example": "101"
              }
            },
            "required": [
              "id"
            ]
          },
          "types": {
            "type": "array",
            "description": "The association types",
            "example": [
              {
                "associationCategory": "HUBSPOT_DEFINED",
                "associationTypeId": 202
              }
            ],
            "items": {
              "type": "object",
              "description": "Type of association",
              "properties": {
                "associationCategory": {
                  "type": "string",
                  "description": "The category of association",
                  "example": "HUBSPOT_DEFINED",
                  "enum": [
                    "HUBSPOT_DEFINED",
                    "USER_DEFINED",
                    "INTEGRATOR_DEFINED"
                  ]
                },
                "associationTypeId": {
                  "type": "integer",
                  "description": "The association type ID",
                  "example": 202
                }
              },
              "required": [
                "associationCategory",
                "associationTypeId"
              ]
            }
          }
        },
        "required": [
          "to",
          "types"
        ]
      }
    }
  },
  "required": [
    "properties"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "NoteCreateRequest"
}