Create or Update Multiple Marketing Events
curl --request POST \
--url https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"customProperties": [
{
"isEncrypted": true,
"isLargeValue": true,
"maskedSubstrings": {
"substrings": [
{
"end": 123,
"start": 123
}
]
},
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": true,
"selectedByUserTimestamp": 123,
"sourceId": "<string>",
"sourceLabel": "<string>",
"sourceMetadata": "<string>",
"sourceUpstreamDeployable": "<string>",
"sourceVid": [
123
],
"timestamp": 123,
"unit": "<string>",
"updatedByUserId": 123,
"useTimestampAsPersistenceTimestamp": true,
"value": "<string>"
}
],
"eventName": "<string>",
"eventOrganizer": "<string>",
"externalAccountId": "<string>",
"externalEventId": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"eventCancelled": true,
"eventCompleted": true,
"eventDescription": "<string>",
"eventType": "<string>",
"eventUrl": "<string>",
"startDateTime": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert"
payload = { "inputs": [
{
"customProperties": [
{
"isEncrypted": True,
"isLargeValue": True,
"maskedSubstrings": { "substrings": [
{
"end": 123,
"start": 123
}
] },
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": True,
"selectedByUserTimestamp": 123,
"sourceId": "<string>",
"sourceLabel": "<string>",
"sourceMetadata": "<string>",
"sourceUpstreamDeployable": "<string>",
"sourceVid": [123],
"timestamp": 123,
"unit": "<string>",
"updatedByUserId": 123,
"useTimestampAsPersistenceTimestamp": True,
"value": "<string>"
}
],
"eventName": "<string>",
"eventOrganizer": "<string>",
"externalAccountId": "<string>",
"externalEventId": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"eventCancelled": True,
"eventCompleted": True,
"eventDescription": "<string>",
"eventType": "<string>",
"eventUrl": "<string>",
"startDateTime": "2023-11-07T05:31:56Z"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: [
{
customProperties: [
{
isEncrypted: true,
isLargeValue: true,
maskedSubstrings: {substrings: [{end: 123, start: 123}]},
name: '<string>',
persistenceTimestamp: 123,
requestId: '<string>',
selectedByUser: true,
selectedByUserTimestamp: 123,
sourceId: '<string>',
sourceLabel: '<string>',
sourceMetadata: '<string>',
sourceUpstreamDeployable: '<string>',
sourceVid: [123],
timestamp: 123,
unit: '<string>',
updatedByUserId: 123,
useTimestampAsPersistenceTimestamp: true,
value: '<string>'
}
],
eventName: '<string>',
eventOrganizer: '<string>',
externalAccountId: '<string>',
externalEventId: '<string>',
endDateTime: '2023-11-07T05:31:56Z',
eventCancelled: true,
eventCompleted: true,
eventDescription: '<string>',
eventType: '<string>',
eventUrl: '<string>',
startDateTime: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inputs' => [
[
'customProperties' => [
[
'isEncrypted' => true,
'isLargeValue' => true,
'maskedSubstrings' => [
'substrings' => [
[
'end' => 123,
'start' => 123
]
]
],
'name' => '<string>',
'persistenceTimestamp' => 123,
'requestId' => '<string>',
'selectedByUser' => true,
'selectedByUserTimestamp' => 123,
'sourceId' => '<string>',
'sourceLabel' => '<string>',
'sourceMetadata' => '<string>',
'sourceUpstreamDeployable' => '<string>',
'sourceVid' => [
123
],
'timestamp' => 123,
'unit' => '<string>',
'updatedByUserId' => 123,
'useTimestampAsPersistenceTimestamp' => true,
'value' => '<string>'
]
],
'eventName' => '<string>',
'eventOrganizer' => '<string>',
'externalAccountId' => '<string>',
'externalEventId' => '<string>',
'endDateTime' => '2023-11-07T05:31:56Z',
'eventCancelled' => true,
'eventCompleted' => true,
'eventDescription' => '<string>',
'eventType' => '<string>',
'eventUrl' => '<string>',
'startDateTime' => '2023-11-07T05:31:56Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert"
payload := strings.NewReader("{\n \"inputs\": [\n {\n \"customProperties\": [\n {\n \"isEncrypted\": true,\n \"isLargeValue\": true,\n \"maskedSubstrings\": {\n \"substrings\": [\n {\n \"end\": 123,\n \"start\": 123\n }\n ]\n },\n \"name\": \"<string>\",\n \"persistenceTimestamp\": 123,\n \"requestId\": \"<string>\",\n \"selectedByUser\": true,\n \"selectedByUserTimestamp\": 123,\n \"sourceId\": \"<string>\",\n \"sourceLabel\": \"<string>\",\n \"sourceMetadata\": \"<string>\",\n \"sourceUpstreamDeployable\": \"<string>\",\n \"sourceVid\": [\n 123\n ],\n \"timestamp\": 123,\n \"unit\": \"<string>\",\n \"updatedByUserId\": 123,\n \"useTimestampAsPersistenceTimestamp\": true,\n \"value\": \"<string>\"\n }\n ],\n \"eventName\": \"<string>\",\n \"eventOrganizer\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalEventId\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"eventCancelled\": true,\n \"eventCompleted\": true,\n \"eventDescription\": \"<string>\",\n \"eventType\": \"<string>\",\n \"eventUrl\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [\n {\n \"customProperties\": [\n {\n \"isEncrypted\": true,\n \"isLargeValue\": true,\n \"maskedSubstrings\": {\n \"substrings\": [\n {\n \"end\": 123,\n \"start\": 123\n }\n ]\n },\n \"name\": \"<string>\",\n \"persistenceTimestamp\": 123,\n \"requestId\": \"<string>\",\n \"selectedByUser\": true,\n \"selectedByUserTimestamp\": 123,\n \"sourceId\": \"<string>\",\n \"sourceLabel\": \"<string>\",\n \"sourceMetadata\": \"<string>\",\n \"sourceUpstreamDeployable\": \"<string>\",\n \"sourceVid\": [\n 123\n ],\n \"timestamp\": 123,\n \"unit\": \"<string>\",\n \"updatedByUserId\": 123,\n \"useTimestampAsPersistenceTimestamp\": true,\n \"value\": \"<string>\"\n }\n ],\n \"eventName\": \"<string>\",\n \"eventOrganizer\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalEventId\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"eventCancelled\": true,\n \"eventCompleted\": true,\n \"eventDescription\": \"<string>\",\n \"eventType\": \"<string>\",\n \"eventUrl\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inputs\": [\n {\n \"customProperties\": [\n {\n \"isEncrypted\": true,\n \"isLargeValue\": true,\n \"maskedSubstrings\": {\n \"substrings\": [\n {\n \"end\": 123,\n \"start\": 123\n }\n ]\n },\n \"name\": \"<string>\",\n \"persistenceTimestamp\": 123,\n \"requestId\": \"<string>\",\n \"selectedByUser\": true,\n \"selectedByUserTimestamp\": 123,\n \"sourceId\": \"<string>\",\n \"sourceLabel\": \"<string>\",\n \"sourceMetadata\": \"<string>\",\n \"sourceUpstreamDeployable\": \"<string>\",\n \"sourceVid\": [\n 123\n ],\n \"timestamp\": 123,\n \"unit\": \"<string>\",\n \"updatedByUserId\": 123,\n \"useTimestampAsPersistenceTimestamp\": true,\n \"value\": \"<string>\"\n }\n ],\n \"eventName\": \"<string>\",\n \"eventOrganizer\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalEventId\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"eventCancelled\": true,\n \"eventCompleted\": true,\n \"eventDescription\": \"<string>\",\n \"eventType\": \"<string>\",\n \"eventUrl\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"createdAt": "2023-11-07T05:31:56Z",
"customProperties": [
{
"isEncrypted": true,
"isLargeValue": true,
"maskedSubstrings": {
"substrings": [
{
"end": 123,
"start": 123
}
]
},
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": true,
"selectedByUserTimestamp": 123,
"sourceId": "<string>",
"sourceLabel": "<string>",
"sourceMetadata": "<string>",
"sourceUpstreamDeployable": "<string>",
"sourceVid": [
123
],
"timestamp": 123,
"unit": "<string>",
"updatedByUserId": 123,
"useTimestampAsPersistenceTimestamp": true,
"value": "<string>"
}
],
"eventName": "<string>",
"eventOrganizer": "<string>",
"id": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"endDateTime": "2023-11-07T05:31:56Z",
"eventCancelled": true,
"eventCompleted": true,
"eventDescription": "<string>",
"eventType": "<string>",
"eventUrl": "<string>",
"objectId": "<string>",
"startDateTime": "2023-11-07T05:31:56Z"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Batch
Create or update events
Upserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created.
Only Marketing Events originally created by the same app can be updated.
POST
/
marketing
/
marketing-events
/
2026-03
/
events
/
upsert
Create or Update Multiple Marketing Events
curl --request POST \
--url https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"customProperties": [
{
"isEncrypted": true,
"isLargeValue": true,
"maskedSubstrings": {
"substrings": [
{
"end": 123,
"start": 123
}
]
},
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": true,
"selectedByUserTimestamp": 123,
"sourceId": "<string>",
"sourceLabel": "<string>",
"sourceMetadata": "<string>",
"sourceUpstreamDeployable": "<string>",
"sourceVid": [
123
],
"timestamp": 123,
"unit": "<string>",
"updatedByUserId": 123,
"useTimestampAsPersistenceTimestamp": true,
"value": "<string>"
}
],
"eventName": "<string>",
"eventOrganizer": "<string>",
"externalAccountId": "<string>",
"externalEventId": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"eventCancelled": true,
"eventCompleted": true,
"eventDescription": "<string>",
"eventType": "<string>",
"eventUrl": "<string>",
"startDateTime": "2023-11-07T05:31:56Z"
}
]
}
'import requests
url = "https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert"
payload = { "inputs": [
{
"customProperties": [
{
"isEncrypted": True,
"isLargeValue": True,
"maskedSubstrings": { "substrings": [
{
"end": 123,
"start": 123
}
] },
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": True,
"selectedByUserTimestamp": 123,
"sourceId": "<string>",
"sourceLabel": "<string>",
"sourceMetadata": "<string>",
"sourceUpstreamDeployable": "<string>",
"sourceVid": [123],
"timestamp": 123,
"unit": "<string>",
"updatedByUserId": 123,
"useTimestampAsPersistenceTimestamp": True,
"value": "<string>"
}
],
"eventName": "<string>",
"eventOrganizer": "<string>",
"externalAccountId": "<string>",
"externalEventId": "<string>",
"endDateTime": "2023-11-07T05:31:56Z",
"eventCancelled": True,
"eventCompleted": True,
"eventDescription": "<string>",
"eventType": "<string>",
"eventUrl": "<string>",
"startDateTime": "2023-11-07T05:31:56Z"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: [
{
customProperties: [
{
isEncrypted: true,
isLargeValue: true,
maskedSubstrings: {substrings: [{end: 123, start: 123}]},
name: '<string>',
persistenceTimestamp: 123,
requestId: '<string>',
selectedByUser: true,
selectedByUserTimestamp: 123,
sourceId: '<string>',
sourceLabel: '<string>',
sourceMetadata: '<string>',
sourceUpstreamDeployable: '<string>',
sourceVid: [123],
timestamp: 123,
unit: '<string>',
updatedByUserId: 123,
useTimestampAsPersistenceTimestamp: true,
value: '<string>'
}
],
eventName: '<string>',
eventOrganizer: '<string>',
externalAccountId: '<string>',
externalEventId: '<string>',
endDateTime: '2023-11-07T05:31:56Z',
eventCancelled: true,
eventCompleted: true,
eventDescription: '<string>',
eventType: '<string>',
eventUrl: '<string>',
startDateTime: '2023-11-07T05:31:56Z'
}
]
})
};
fetch('https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inputs' => [
[
'customProperties' => [
[
'isEncrypted' => true,
'isLargeValue' => true,
'maskedSubstrings' => [
'substrings' => [
[
'end' => 123,
'start' => 123
]
]
],
'name' => '<string>',
'persistenceTimestamp' => 123,
'requestId' => '<string>',
'selectedByUser' => true,
'selectedByUserTimestamp' => 123,
'sourceId' => '<string>',
'sourceLabel' => '<string>',
'sourceMetadata' => '<string>',
'sourceUpstreamDeployable' => '<string>',
'sourceVid' => [
123
],
'timestamp' => 123,
'unit' => '<string>',
'updatedByUserId' => 123,
'useTimestampAsPersistenceTimestamp' => true,
'value' => '<string>'
]
],
'eventName' => '<string>',
'eventOrganizer' => '<string>',
'externalAccountId' => '<string>',
'externalEventId' => '<string>',
'endDateTime' => '2023-11-07T05:31:56Z',
'eventCancelled' => true,
'eventCompleted' => true,
'eventDescription' => '<string>',
'eventType' => '<string>',
'eventUrl' => '<string>',
'startDateTime' => '2023-11-07T05:31:56Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert"
payload := strings.NewReader("{\n \"inputs\": [\n {\n \"customProperties\": [\n {\n \"isEncrypted\": true,\n \"isLargeValue\": true,\n \"maskedSubstrings\": {\n \"substrings\": [\n {\n \"end\": 123,\n \"start\": 123\n }\n ]\n },\n \"name\": \"<string>\",\n \"persistenceTimestamp\": 123,\n \"requestId\": \"<string>\",\n \"selectedByUser\": true,\n \"selectedByUserTimestamp\": 123,\n \"sourceId\": \"<string>\",\n \"sourceLabel\": \"<string>\",\n \"sourceMetadata\": \"<string>\",\n \"sourceUpstreamDeployable\": \"<string>\",\n \"sourceVid\": [\n 123\n ],\n \"timestamp\": 123,\n \"unit\": \"<string>\",\n \"updatedByUserId\": 123,\n \"useTimestampAsPersistenceTimestamp\": true,\n \"value\": \"<string>\"\n }\n ],\n \"eventName\": \"<string>\",\n \"eventOrganizer\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalEventId\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"eventCancelled\": true,\n \"eventCompleted\": true,\n \"eventDescription\": \"<string>\",\n \"eventType\": \"<string>\",\n \"eventUrl\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [\n {\n \"customProperties\": [\n {\n \"isEncrypted\": true,\n \"isLargeValue\": true,\n \"maskedSubstrings\": {\n \"substrings\": [\n {\n \"end\": 123,\n \"start\": 123\n }\n ]\n },\n \"name\": \"<string>\",\n \"persistenceTimestamp\": 123,\n \"requestId\": \"<string>\",\n \"selectedByUser\": true,\n \"selectedByUserTimestamp\": 123,\n \"sourceId\": \"<string>\",\n \"sourceLabel\": \"<string>\",\n \"sourceMetadata\": \"<string>\",\n \"sourceUpstreamDeployable\": \"<string>\",\n \"sourceVid\": [\n 123\n ],\n \"timestamp\": 123,\n \"unit\": \"<string>\",\n \"updatedByUserId\": 123,\n \"useTimestampAsPersistenceTimestamp\": true,\n \"value\": \"<string>\"\n }\n ],\n \"eventName\": \"<string>\",\n \"eventOrganizer\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalEventId\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"eventCancelled\": true,\n \"eventCompleted\": true,\n \"eventDescription\": \"<string>\",\n \"eventType\": \"<string>\",\n \"eventUrl\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inputs\": [\n {\n \"customProperties\": [\n {\n \"isEncrypted\": true,\n \"isLargeValue\": true,\n \"maskedSubstrings\": {\n \"substrings\": [\n {\n \"end\": 123,\n \"start\": 123\n }\n ]\n },\n \"name\": \"<string>\",\n \"persistenceTimestamp\": 123,\n \"requestId\": \"<string>\",\n \"selectedByUser\": true,\n \"selectedByUserTimestamp\": 123,\n \"sourceId\": \"<string>\",\n \"sourceLabel\": \"<string>\",\n \"sourceMetadata\": \"<string>\",\n \"sourceUpstreamDeployable\": \"<string>\",\n \"sourceVid\": [\n 123\n ],\n \"timestamp\": 123,\n \"unit\": \"<string>\",\n \"updatedByUserId\": 123,\n \"useTimestampAsPersistenceTimestamp\": true,\n \"value\": \"<string>\"\n }\n ],\n \"eventName\": \"<string>\",\n \"eventOrganizer\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalEventId\": \"<string>\",\n \"endDateTime\": \"2023-11-07T05:31:56Z\",\n \"eventCancelled\": true,\n \"eventCompleted\": true,\n \"eventDescription\": \"<string>\",\n \"eventType\": \"<string>\",\n \"eventUrl\": \"<string>\",\n \"startDateTime\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"createdAt": "2023-11-07T05:31:56Z",
"customProperties": [
{
"isEncrypted": true,
"isLargeValue": true,
"maskedSubstrings": {
"substrings": [
{
"end": 123,
"start": 123
}
]
},
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": true,
"selectedByUserTimestamp": 123,
"sourceId": "<string>",
"sourceLabel": "<string>",
"sourceMetadata": "<string>",
"sourceUpstreamDeployable": "<string>",
"sourceVid": [
123
],
"timestamp": 123,
"unit": "<string>",
"updatedByUserId": 123,
"useTimestampAsPersistenceTimestamp": true,
"value": "<string>"
}
],
"eventName": "<string>",
"eventOrganizer": "<string>",
"id": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"endDateTime": "2023-11-07T05:31:56Z",
"eventCancelled": true,
"eventCompleted": true,
"eventDescription": "<string>",
"eventType": "<string>",
"eventUrl": "<string>",
"objectId": "<string>",
"startDateTime": "2023-11-07T05:31:56Z"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Show child attributes
Show child attributes
Response
successful operation
Timestamp of when the request was completed.
Show child attributes
Show child attributes
Timestamp of when the request started processing.
Status of the response.
Available options:
CANCELED, COMPLETE, PENDING, PROCESSING Show child attributes
Show child attributes
Result of the request.
Show child attributes
Show child attributes
The number of errors that occurred during the request.
Timestamp of when the request was sent.
Last modified on March 31, 2026
Was this page helpful?
⌘I