Transaktions-E-Mail
Abo-Einstellungen v3
Abo-Einstellungen v4
Marketing-E-Mails
Marketingevents
Kampagnen
Formulare
Meetings
curl --request POST \
--url https://api.hubapi.com/marketing/v3/marketing-events/events/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"customProperties": [
{
"dataSensitivity": "high",
"isEncrypted": true,
"isLargeValue": true,
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": true,
"selectedByUserTimestamp": 123,
"source": "ACADEMY",
"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"
}
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"createdAt": "2023-11-07T05:31:56Z",
"customProperties": [
{
"dataSensitivity": "high",
"isEncrypted": true,
"isLargeValue": true,
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": true,
"selectedByUserTimestamp": 123,
"source": "ACADEMY",
"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",
"status": "CANCELED",
"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"
}Mehrere Marketingevents erstellen oder aktualisieren
Aktualisiert mehrere Marketingevents mit einem Upsert und fügt diese ein. Wenn ein Marketingevent mit der angegebenen ID bereits existiert, wird es aktualisiert; andernfalls wird ein neues Event erstellt.
Es werden nur Marketingevents aktualisiert, die von denselben Apps erstellt wurden.
curl --request POST \
--url https://api.hubapi.com/marketing/v3/marketing-events/events/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"customProperties": [
{
"dataSensitivity": "high",
"isEncrypted": true,
"isLargeValue": true,
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": true,
"selectedByUserTimestamp": 123,
"source": "ACADEMY",
"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"
}
]
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"createdAt": "2023-11-07T05:31:56Z",
"customProperties": [
{
"dataSensitivity": "high",
"isEncrypted": true,
"isLargeValue": true,
"name": "<string>",
"persistenceTimestamp": 123,
"requestId": "<string>",
"selectedByUser": true,
"selectedByUserTimestamp": 123,
"source": "ACADEMY",
"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",
"status": "CANCELED",
"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"
}Unterstützte Produkte
Unterstützte Produkte
Marketing Hub -Kostenlos
Sales Hub -Kostenlos
Service Hub -Kostenlos
Content Hub -StarterErforderliche Bereiche
Erforderliche Bereiche
crm.objects.marketing_events.writeAuthorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
Eine PropertyValues-Liste. Es kann sich um beliebige Eigenschaftsnamen und -werte handeln, die jedoch bereits in der Definition des MarketingEvent-Objekts im HubSpot-Account enthalten sein müssen. Ist dies nicht der Fall, werden sie herausgefiltert und nicht festgelegt. Um dies auszuschließen, müssen Sie für Ihre App eine neue PropertyGroup für das MarketingEvent-Objekt im HubSpot-Account sowie die benutzerdefinierte Eigenschaft erstellen, die Sie in diesem HubSpot-Account nachverfolgen möchten. Erstellen Sie keine neuen Standardeigenschaften für das MarketingEvent-Objekt, da dies auf alle HubSpot-Accounts angewendet wird.
Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
The sensitivity level of the property, such as "non_sensitive", "sensitive", and "highly_sensitive".
high, none, standard Whether the property value is encrypted.
Gibt an, ob der Eigenschaftswert als großer Wert im Speicher gespeichert wird.
Name der benutzerdefinierten Eigenschaft
Der Zeitstempel, der angibt, wann der geschriebene Wert im Speicher persistent gespeichert wird.
A unique ID associated with this request.
Whether the value was selected by a user.
The timestamp when the value was selected by a user, if applicable.
The origin of the property value, such as "IMPORT" or "API".
ACADEMY, ACCEPTANCE_TEST, ACTIVITY_AUTO_ASSOCIATE, ADS, AI_GROUP, ANALYTICS, API, APPROVALS, ASSISTS, ASSOCIATIONS, AUTO_ASSOCIATE_BY_DOMAIN, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM, AVATARS_SERVICE, BATCH_UPDATE, BCC_TO_CRM, BEHAVIORAL_EVENTS, BET_ASSIGNMENT, BET_CRM_CONNECTOR, BIDEN, BILLING, BOT, CALCULATED, CENTRAL_EXCHANGE_RATES, CHATSPOT, CLONE_OBJECTS, COMMUNICATOR, COMPANIES, COMPANY_FAMILIES, COMPANY_INSIGHTS, CONTACTS, CONTACTS_WEB, CONTENT_MEMBERSHIP, CONVERSATIONAL_ENRICHMENT, CONVERSATIONS, CRM_PROCESSES_PLATFORM, CRM_UI, CRM_UI_BULK_ACTION, CUSTOMER_AGENT, DATA_ENRICHMENT, DATASET, DEALS, DEFAULT, DELETE_OBJECTS, EMAIL, EMAIL_INBOX_IMPORT, EMAIL_INTEGRATION, ENGAGEMENTS, EXTENSION, FILE_MANAGER, FLYWHEEL_PRODUCT_DATA_SYNC, FORECASTING, FORM, FORWARD_TO_CRM, GMAIL_INTEGRATION, GOALS, HEISENBERG, HELP_DESK, HELP_DESK_AI, IMPORT, INTEGRATION, INTEGRATIONS_PLATFORM, INTEGRATIONS_SYNC, INTENT, INTERNAL_PROCESSING, LEADIN, LEGAL_BASIS_REMEDIATION, MARKET_SOURCING, MARKETPLACE, MEETINGS, MERGE_COMPANIES, MERGE_CONTACTS, MERGE_OBJECTS, MERGE_REVERT_OBJECTS, MICROAPPS, MIGRATION, MOBILE_ANDROID, MOBILE_IOS, PAYMENTS, PIPELINE_SETTINGS, PLAYBOOKS, PORTAL_OBJECT_SYNC, PORTAL_USER_ASSOCIATOR, PRESENTATIONS, PRIMARY_AUTOMATION, PROPERTY_DEFAULT_VALUE, PROPERTY_RESTORE, PROPERTY_SETTINGS, PROSPECTING_AGENT, QUOTAS, QUOTES, RECYCLING_BIN, RESTORE_OBJECTS, SALES, SALES_MESSAGES, SALESFORCE, SEQUENCES, SETTINGS, SIDEKICK, SIGNALS, SLACK_INTEGRATION, SOCIAL, SUCCESS, TALLY, TASK, UNKNOWN, WAL_INCREMENTAL, WORK_UI, WORKFLOW_CONTACT_DELETE_ACTION, WORKFLOWS The ID of the property source indicating where it was created.
A human-readable label.
Quellen-Metadaten kodiert als base64-Zeichenfolge. Beispiel: „ZXhhbXBsZSBzdHJpbmc=“
Gibt an, welcher Upstream-Dienst die Eigenschaftsänderung vorgenommen hat.
The unique identifier associated with the source.
When the value was set, as a 64-bit integer.
The unit of measurement or context for the value.
The ID of the user who updated the property.
Gibt an, ob der Persistenzzeitstempel mit dem Zeitstempel der Speicherversion übereinstimmt.
Benutzerdefinierter Eigenschaftswert
Der Name des Marketingevents.
Der Name des Organisators des Marketingevents.
Die accountId, die diesem Marketingevent in der externen Event-App zugeordnet ist.
Die ID des Marketingevents in der externen Event-App.
Der Endzeitpunkt (Datum und Uhrzeit) des Marketingevents.
Gibt an, ob das Marketingevent storniert wurde. Der Standardwert ist „false“ (falsch).
Gibt an, ob das Marketingevent abgeschlossen wurde. Der Standardwert ist „false“ (falsch)
Die Beschreibung des Marketingevents.
Beschreibt, von welchem Typ dieses Event ist. Beispiel: „WEBINAR“, „CONFERENCE“, „WORKSHOP“
Eine URL in der externen Event-App, in der das Marketingevent verwaltet werden kann.
Der Startzeitpunkt (Datum und Uhrzeit) des Marketingevents.
Response
successful operation
Zeitstempel, wann die Anfrage abgeschlossen wurde.
Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
Der Erstellungszeitpunkt (Datum und Uhrzeit) des Marketingevents.
Eine PropertyValues-Liste. Es kann sich um beliebige Eigenschaftsnamen und -werte handeln, die jedoch bereits in der Definition des MarketingEvent-Objekts im HubSpot-Account enthalten sein müssen. Ist dies nicht der Fall, werden sie herausgefiltert und nicht festgelegt. Um dies auszuschließen, müssen Sie für Ihre App eine neue PropertyGroup für das MarketingEvent-Objekt im HubSpot-Account sowie die benutzerdefinierte Eigenschaft erstellen, die Sie in diesem HubSpot-Account nachverfolgen möchten. Erstellen Sie keine neuen Standardeigenschaften für das MarketingEvent-Objekt, da dies auf alle HubSpot-Accounts angewendet wird.
Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
The sensitivity level of the property, such as "non_sensitive", "sensitive", and "highly_sensitive".
high, none, standard Whether the property value is encrypted.
Gibt an, ob der Eigenschaftswert als großer Wert im Speicher gespeichert wird.
Name der benutzerdefinierten Eigenschaft
Der Zeitstempel, der angibt, wann der geschriebene Wert im Speicher persistent gespeichert wird.
A unique ID associated with this request.
Whether the value was selected by a user.
The timestamp when the value was selected by a user, if applicable.
The origin of the property value, such as "IMPORT" or "API".
ACADEMY, ACCEPTANCE_TEST, ACTIVITY_AUTO_ASSOCIATE, ADS, AI_GROUP, ANALYTICS, API, APPROVALS, ASSISTS, ASSOCIATIONS, AUTO_ASSOCIATE_BY_DOMAIN, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM, AVATARS_SERVICE, BATCH_UPDATE, BCC_TO_CRM, BEHAVIORAL_EVENTS, BET_ASSIGNMENT, BET_CRM_CONNECTOR, BIDEN, BILLING, BOT, CALCULATED, CENTRAL_EXCHANGE_RATES, CHATSPOT, CLONE_OBJECTS, COMMUNICATOR, COMPANIES, COMPANY_FAMILIES, COMPANY_INSIGHTS, CONTACTS, CONTACTS_WEB, CONTENT_MEMBERSHIP, CONVERSATIONAL_ENRICHMENT, CONVERSATIONS, CRM_PROCESSES_PLATFORM, CRM_UI, CRM_UI_BULK_ACTION, CUSTOMER_AGENT, DATA_ENRICHMENT, DATASET, DEALS, DEFAULT, DELETE_OBJECTS, EMAIL, EMAIL_INBOX_IMPORT, EMAIL_INTEGRATION, ENGAGEMENTS, EXTENSION, FILE_MANAGER, FLYWHEEL_PRODUCT_DATA_SYNC, FORECASTING, FORM, FORWARD_TO_CRM, GMAIL_INTEGRATION, GOALS, HEISENBERG, HELP_DESK, HELP_DESK_AI, IMPORT, INTEGRATION, INTEGRATIONS_PLATFORM, INTEGRATIONS_SYNC, INTENT, INTERNAL_PROCESSING, LEADIN, LEGAL_BASIS_REMEDIATION, MARKET_SOURCING, MARKETPLACE, MEETINGS, MERGE_COMPANIES, MERGE_CONTACTS, MERGE_OBJECTS, MERGE_REVERT_OBJECTS, MICROAPPS, MIGRATION, MOBILE_ANDROID, MOBILE_IOS, PAYMENTS, PIPELINE_SETTINGS, PLAYBOOKS, PORTAL_OBJECT_SYNC, PORTAL_USER_ASSOCIATOR, PRESENTATIONS, PRIMARY_AUTOMATION, PROPERTY_DEFAULT_VALUE, PROPERTY_RESTORE, PROPERTY_SETTINGS, PROSPECTING_AGENT, QUOTAS, QUOTES, RECYCLING_BIN, RESTORE_OBJECTS, SALES, SALES_MESSAGES, SALESFORCE, SEQUENCES, SETTINGS, SIDEKICK, SIGNALS, SLACK_INTEGRATION, SOCIAL, SUCCESS, TALLY, TASK, UNKNOWN, WAL_INCREMENTAL, WORK_UI, WORKFLOW_CONTACT_DELETE_ACTION, WORKFLOWS The ID of the property source indicating where it was created.
A human-readable label.
Quellen-Metadaten kodiert als base64-Zeichenfolge. Beispiel: „ZXhhbXBsZSBzdHJpbmc=“
Gibt an, welcher Upstream-Dienst die Eigenschaftsänderung vorgenommen hat.
The unique identifier associated with the source.
When the value was set, as a 64-bit integer.
The unit of measurement or context for the value.
The ID of the user who updated the property.
Gibt an, ob der Persistenzzeitstempel mit dem Zeitstempel der Speicherversion übereinstimmt.
Benutzerdefinierter Eigenschaftswert
Der Name des Marketingevents.
Der Name des Organisators des Marketingevents.
Die ID des CRM-Objekts für das Marketingevent.
Der Aktualisierungszeitpunkt (Datum und Uhrzeit) des Marketingevents.
Der Endzeitpunkt (Datum und Uhrzeit) des Marketingevents.
Gibt an, ob das Marketingevent storniert wurde.
Gibt an, ob das Marketing-Event abgeschlossen wurde.
Die Beschreibung des Marketingevents.
Der Typ von Marketingevent.
Eine URL in der externen Event-App, in der das Marketingevent verwaltet werden kann.
Die ID des CRM-Objekts für das Marketingevent.
Der Startzeitpunkt (Datum und Uhrzeit) des Marketingevents.
Zeitstempel, wann das Verarbeiten der Anfrage begonnen hat.
Status der Antwort.
CANCELED, COMPLETE, PENDING, PROCESSING Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
The main category of the error.
The detailed error objects.
Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
Eine für Menschen lesbare Nachricht mit einer Beschreibung des Fehlers und ggf. Abhilfemaßnahmen
Der Statuscode, der dem Fehlerdetail zugeordnet ist
Der Name des Felds oder Parameters, in dem der Fehler gefunden wurde
Eine spezifische Kategorie, die genauere Details zum Fehler enthält
A human-readable string describing the error and possible remediation steps.
The HTTP status code associated with the error.
A unique ID for the error instance.
A more specific error category within each main category.
Die Anzahl der während der Anfrage aufgetretenen Fehler.
Zeitstempel, wann die Anfrage gesendet wurde.