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 |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/engagement-notes-note-create-request-schema.json",
"title": "NoteCreateRequest",
"description": "Request body for creating a note",
"type": "object",
"properties": {
"properties": {
"type": "object",
"description": "The note properties to set",
"additionalProperties": {
"type": "string"
},
"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",
"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": 202
}
]
}
}
},
"example": [
{
"to": {
"id": {}
},
"types": [
{}
]
}
]
}
},
"required": [
"properties"
]
}