Benutzerdefinierte Objekte

ÜberblickObjekteObjektschema
APPLICABLE PRODUCTS
  • Marketing Hub
    • Enterprise
  • Sales Hub
    • Enterprise
  • Service Hub
    • Enterprise
  • Content Hub
    • Enterprise
  • Operations Hub
    • Enterprise

In jedem HubSpot-Account gibt es die Standard-CRM-Objekte: Kontakte, Unternehmen, Deals und Tickets. Um Ihre CRM-Daten basierend auf Ihren Geschäftsanforderungen darzustellen und zu organisieren, können Sie auch benutzerdefinierte Objekte erstellen. In HubSpot können Sie ein benutzerdefiniertes Objekt erstellen oder die API für benutzerdefinierte Objekte verwenden, um benutzerdefinierte Objekte, Eigenschaften und Zuordnungen zu anderen CRM-Objekten zu definieren. 

Nachfolgend erfahren Sie, wie Sie benutzerdefinierte Objekte über die API erstellen und verwalten, und werden anhand eines Beispiels durch das Erstellen eines benutzerdefinierten Objekts geführt.

Weitere Informationen zum Erstellen benutzerdefinierter Objekte finden Sie in den folgenden Beiträgen im HubSpot-Entwicklerblog:

Bitte beachten: Benutzerdefinierte Objekte sind für jedes Account spezifisch, und je nach Abonnement bestehen Beschränkungen hinsichtlich der Anzahl der benutzerdefinierten Objekte, die Sie erstellen können. Erfahren Sie in der Übersicht der Produkte und Dienstleistungen von HubSpot mehr über Ihre Limits.

Authentifizierungsmethoden

Sie können benutzerdefinierte Objekte mithilfe einer der folgenden Authentifizierungsmethoden erstellen, lesen und aktualisieren:

Bitte beachten: Seit dem 30. November 2022 sind HubSpot-API-Schlüssel veraltet und werden nicht mehr unterstützt. Die fortgesetzte Verwendung von HubSpot API-Schlüsseln stellt ein Sicherheitsrisiko für Ihren Account und Ihre Daten dar. Während dieser Phase bis zur endgültigen Einstellung kann HubSpot Ihren Schlüssel jederzeit deaktivieren.

Sie sollten sich stattdessen mit einem Zugriffstoken für private Apps oder über OAuth authentifizieren. Erfahren Sie mehr über diese Änderung und wie Sie eine API-Schlüssel-Integration migrieren, um stattdessen eine private App zu verwenden.

Ein benutzerdefiniertes Objekt erstellen

Um ein benutzerdefiniertes Objekt zu erstellen, müssen Sie zunächst das Objektschema definieren. Das Schema enthält den Objektnamen, Eigenschaften und Zuordnungen zu anderen CRM-Objekten. Die vollständigen Schema-Anfragedetails finden Sie oben in diesem Artikel auf der Registerkarte Objektschema. Sie können sich auch eine Beispielanfrage in der Beispieldemonstration unten ansehen.

Um das benutzerdefinierte Objektschema zu erstellen, führen Sie eine POST-Anfrage an crm/v3/schemas durch. Fügen Sie im Anfragetext Definitionen für Ihr Objektschema ein, einschließlich Name, Eigenschaften und Zuordnungen.

Wenn Sie Ihr benutzerdefiniertes Objekt benennen, beachten Sie Folgendes:

  • Sobald Sie ein Objekt erstellt haben, können der Name und das Label nicht mehr geändert werden.
  • Der Name darf nur Buchstaben, Ziffern und Unterstriche enthalten.
  • Das erste Zeichen des Namens muss ein Buchstabe sein.
  • Lange Label können in bestimmten Teilen des Produkts abgeschnitten werden.

Im Folgenden finden Sie die erforderlichen Definitionen für die Eigenschaften und Zuordnungen des Objekts. 

Eigenschaften

Die Eigenschaften, die Sie im Anfragetext definieren, werden verwendet, um Informationen zu einzelnen benutzerdefinierten Objektdatensätzen zu speichern.

Bitte beachten: Sie können bis zu 10 „Eindeutige Wert“-Eigenschaften für jedes benutzerdefinierte Objekt in Ihrem HubSpot-Account haben.

Sie verwenden Ihre definierten Eigenschaften, um die folgenden eigenschaftsbasierten Felder zu füllen:

  • requiredProperties: Die Eigenschaften, die beim Erstellen eines neuen benutzerdefinierten Objektdatensatzes erforderlich sind.
  • searchableProperties: Die Eigenschaften, die für die Suche in HubSpot indiziert werden.
  • primaryDisplayProperty: Die Eigenschaft, die zum Benennen einzelner benutzerdefinierter Objektdatensätze verwendet wird.
  • secondaryDisplayProperties: Die Eigenschaften, die in einzelnen Datensätzen unter der primären Anzeigeeigenschaft angezeigt werden.
    custom-object-secondary-display-properties0
    • Die erste Eigenschaft, die in secondaryDisplayProperties aufgeführt ist, wird auch als vierter Filter auf der Indexseite des Objekts hinzugefügt, wenn es sich um einen der folgenden Eigenschaftstypen handelt:
      • string
      • number
      • enumeration
      • boolean
      • datetime
        custom-object-dashboard-filter0
    • Um eine Anzeigeeigenschaft von der Benutzeroberfläche zu entfernen, müssen Sie die Eigenschaft zunächst löschen und dann neu erstellen.

Beim Erstellen von Eigenschaften über die Schemaanfrage wird standardmäßig der type der Eigenschaft auf string und der fieldType auf text festgelegt. Unten sind die Werte, die Sie verwenden können, um verschiedene Typen von Eigenschaften zu erstellen.

Zulässige Werte für type
type Beschreibung Zulässige fieldType-Werte
enumeration Eine Zeichenfolge, die eine Reihe von Optionen enthält, die durch ein Semikolon getrennt sind  booleancheckbox, checkbox, radio, select
date Ein ISO 8601-formatierter Wert, der einen bestimmten Tag, einen bestimmten Monat und ein bestimmtes Jahr darstellt. date
dateTime Ein ISO 8601-formatierter Wert, der einen bestimmten Tag, einen bestimmten Monat, ein bestimmtes Jahr und eine bestimmte Uhrzeit darstellt. Die HubSpot-App zeigt nicht die Uhrzeit an. date
string Eine Klartext-Zeichenfolge, die auf 65.536 Zeichen begrenzt ist. file, text, textarea
number Ein Zahlenwert mit numerischen Ziffern und höchstens einer Dezimalstelle. number
Zulässige Werte für fieldType 
fieldType Beschreibung
booleancheckbox Eine Eingabe, die es Benutzern ermöglicht, entweder „Ja“ oder „Nein“ auszuwählen. Bei Verwendung in einem Formular wird sie als einzelnes Kontrollkästchen angezeigt.
checkbox Eine Liste der Kontrollkästchen, anhand derer ein Benutzer mehrere Optionen aus einer Reihe von Optionen auswählen kann, die für die Eigenschaft zulässig sind.
date Ein Datumswert, der als Datumsauswahl angezeigt wird.
file Ermöglicht, dass eine Datei zu einem Formular hochgeladen wird. Wird als URL-Link gespeichert und der Datei angezeigt.
number Eine Ziffernfolge oder Zahlen in Dezimalschreibweise oder in wissenschaftlicher Notation.
radio Eine Eingabe, die es Benutzern ermöglicht, eine Option aus einer Reihe von Optionen auszuwählen, die für die Eigenschaft zulässig sind. Bei Verwendung in einem Formular wird dies als eine Reihe von Optionsfeldern angezeigt.
select Eine Dropdown-Eingabe, die es Benutzern ermöglicht, eine Option aus einer Reihe von Optionen auszuwählen, die für die Eigenschaft zulässig sind.
text Eine Klartext-Zeichenfolge, die als eine einzeilige Texteingabe angezeigt wird.
textarea Eine Klartext-Zeichenfolge, die als eine mehrzeilige Texteingabe angezeigt wird.

Zuordnungen

HubSpot ordnet den E-Mails, Meetings, Notizen, Aufgaben, Anrufen und Konversationen automatisch ein benutzerdefiniertes Objekt zu. Sie können außerdem Ihr benutzerdefiniertes Objekt auch mit anderen Standard-HubSpot-Objekten oder anderen benutzerdefinierten Objekten verknüpfen.

Identifizieren Sie beim Erstellen von Zuordnungen über die Anfrage zum Erstellen eines Schemas Standardobjekte anhand ihres Namens und benutzerdefinierte Objekte anhand ihres objectTypeId-Werts. Zum Beispiel:

// Example associatedObjects array "associatedObjects": [ "CONTACT", "COMPANY", "TICKET", "DEAL", "2-3453932" ]

Vorhandene benutzerdefinierte Objekte abrufen

Um alle benutzerdefinierten Objekte abzurufen, führen Sie eine GET-Anfrage an /crm/v3/schemas durch.

Um ein bestimmtes benutzerdefiniertes Objekt abzurufen, führen Sie eine GET-Anfrage an einen der folgenden Endpunkte durch:

  • /crm/v3/schemas/{objectTypeId}
  • /crm/v3/schemas/p_{object_name}
  • /crm/v3/schemas/{fullyQualifiedName}. Sie können den

    fullyQualifiedName eines Objekts in seinem Schema finden, das von p{portal_id}_{object_name} abgeleitet wird. Sie können die Portal-ID Ihres Accounts mithilfe der Account-Informationen-API finden.

Für einen Account mit der ID 1234 und ein Objekt mit dem Namen lender könnte Ihre Anfrage-URL beispielsweise wie folgt aussehen:

Benutzerdefinierte Objektdatensätze abrufen

Sie können auch die Datensätze eines benutzerdefinierten Objekts abrufen.

  • Um einen bestimmten Datensatz nach seinem Datensatz-ID-Wert abzurufen, führen Sie eine GET-Anfrage an crm/v3/objects/{objectType}/{recordId} durch.

Sie können für diesen Endpunkt die folgenden Abfrageparameter in die Anfrage-URL einschließen: 

Use this table to describe parameters / fields
ParameterDescription
properties

Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn der angefragte benutzerdefinierte Objektdatensatz keinen Wert für eine Eigenschaft hat, wird er nicht in der Antwort angezeigt.

propertiesWithHistory

Eine durch Kommas getrennte Liste der aktuellen und historischen Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn der angefragte benutzerdefinierte Objektdatensatz keinen Wert für eine Eigenschaft hat, wird er nicht in der Antwort angezeigt.

associations

Eine durch Kommas getrennte Liste von Objekten, für die zugehörige IDs abgerufen werden sollen. Alle angegebenen Zuordnungen, die nicht vorhanden sind, werden nicht in der Antwort zurückgegeben. Erfahren Sie mehr über die Zuordnungen-API.
  • Um mehrere Datensätze abzurufen, führen Sie eine POST-Anfrage an crm/v3/objects/{objectType}/batch/read durch. Der Batch-Endpunkt kann Zuordnungen nicht abrufen. Erfahren Sie, wie Sie Zuordnungen mit der Zuordnungen-API stapelweise lesen.

In Ihrer Anfrage können Sie Datensätze nach ihrer Datensatz-ID (hs_object_id) abrufen oder nach einer benutzerdefinierten „Eindeutige ID“-Eigenschaft. Standardmäßig beziehen sich die id-Werte in der Anfrage auf die Datensatz-ID, sodass der idProperty-Parameter beim Abrufen nach Datensatz-ID nicht erforderlich ist. Um eine benutzerdefinierte „Eindeutiger Wert“-Eigenschaft zu verwenden, müssen Sie den idProperty-Parameter einschließen.

Um beispielsweise einen Batch von benutzerdefinierten Objektdatensätzen abzurufen, könnte Ihre Anfrage wie folgt aussehen:

///Example request body for record ID { "properties": [ "petname" ], "inputs": [ { "id": "12345" }, { "id": "67891" } ] }
///Example request body for unique value property { "properties": [ "petname" ], "idProperty": "uniquepropertyexample", "inputs": [ { "id": "abc" }, { "id": "def" } ] }
Um benutzerdefinierte Objektdatensätze mit aktuellen und historischen Werten für eine Eigenschaft abzurufen, könnte Ihre Anfrage wie folgt aussehen:
///Example request body for record ID (current and historical values) { "propertiesWithHistory": [ "pet_owner" ], "inputs": [ { "id": "12345" }, { "id": "67891" } ] }

Vorhandene benutzerdefinierte Objekte aktualisieren

Um das Schema eines Objekts zu aktualisieren, führen Sie eine PATCH-Anfrage an https://api.hubapi.com/crm/v3/schemas/{objectTypeId} durch.

Sobald Ihr benutzerdefiniertes Objekt definiert ist:

  • Der Name und das Label des Objekts (Singular und Plural) können nicht geändert werden.
  • Die requiredProperties, searchableProperties, primaryDisplayProperty und secondaryDisplayProperties können durch Aktualisieren des Schemas des Objekts geändert werden. Um eine neue Eigenschaft als erforderlich, durchsuchbar oder Anzeigeeigenschaft festzulegen, müssen Sie die Eigenschaft vor dem Aktualisieren des Schemas erstellen.
  • Sie können benutzerdefinierte Objekteigenschaften entweder in HubSpot oder über die Eigenschaften-API erstellen und bearbeiten. 

Zuordnungen aktualisieren

Um weitere Objektzuordnungen zu Ihrem benutzerdefinierten Objekt hinzuzufügen, führen Sie eine POST-Anfrage an/crm/v3/schemas/{objectTypeId}/associations durch.

Sie können Ihr benutzerdefiniertes Objekt nur Standard-HubSpot-Objekten (z. B. Kontakte, Unternehmen, Deals oder Tickets) oder anderen benutzerdefinierten Objekten zuordnen. Identifizieren Sie im toObjectTypeId-Feld benutzerdefinierte Objekte nach ihrem objectTypeId-Wert und Standardobjekte nach ihrem Namen. Beispiel:

// Example association request body { "fromObjectTypeId": "2-3444025", "toObjectTypeId": "ticket", "name": "cat_to_ticket" }

Ein benutzerdefiniertes Objekt löschen

Sie können ein benutzerdefiniertes Objekt nur löschen, nachdem alle Objektinstanzen von diesem Typ gelöscht wurden. Um ein benutzerdefiniertes Objekt zu löschen, führen Sie eine DELETE-Anfrage an /crm/v3/schemas/{objectType} durch.

Wenn Sie ein neues benutzerdefiniertes Objekt mit dem gleichen Namen wie das gelöschte Objekt erstellen müssen, müssen Sie das Schema dauerhaft löschen, indem Sie eine DELETE-Anfrage an /crm/v3/schemas/{objectType}?archived=true durchführen. Sie können einen benutzerdefinierten Objekttyp nur löschen, nachdem alle Objektinstanzen von diesem Typ, alle Zuordnungen und benutzerdefinierten Objekteigenschaften gelöscht wurden.

Beispiel für benutzerdefiniertes Objekt

Im Folgenden finden Sie eine Demonstration zum Erstellen eines benutzerdefinierten Beispielobjekts. Die vollständigen Informationen der angezeigten Anfragen finden Sie auf der Registerkarte „Objektdefinition“ oben im Artikel.

In dieser Demonstration wird Folgendes behandelt:

  1. Das Erstellen eines benutzerdefinierten Objektschemas.
  2. Das Erstellen eines benutzerdefinierten Objektdatensatzes.
  3. Das Zuordnen eines benutzerdefinierten Objektdatensatzes zu einem HubSpot-Kontakt.
  4. Das Erstellen einer neuen Zuordnungsdefinition zwischen dem benutzerdefinierten Objekt und dem HubSpot-Ticket.
  5. Das Erstellen einer neuen Eigenschaftsdefinition.
  6. Das Aktualisieren des Objektschemas (d. h. secondaryDisplayProperties) mit der neuen Eigenschaft.

Ziel: Ein Autohaus namens CarSpot möchte seinen Bestand mithilfe eines benutzerdefinierten Objekts in HubSpot speichern. Um die Fahrzeughaltung und die Käufe von Fahrzeugen nachzuverfolgen, ordnet CarSpot Autos Kontaktdatensätzen zu. In Rahmen dieses Plans verfolgt CarSpot auch die Fahrzeugwartung mithilfe von HubSpot-Tickets und benutzerdefinierten Eigenschaften nach.

Erstellen des Objektschemas

CarSpot muss ein Objektschema erstellen, das die folgenden Attribute als Eigenschaften darstellen kann: 

  1. Zustand (neu oder gebraucht): Enumeration
  2. Datum des Eingangs beim Händler: Datum
  3. Jahr: Zahl
  4. Automarke: Zeichenfolge
  5. Modell: Zeichenfolge
  6. VIN: Zeichenfolge (eindeutiger Wert)
  7. Farbe: Zeichenfolge
  8. Kilometerstand: Zahl
  9. Preis: Zahl
  10. Anmerkungen: Zeichenfolge

Das Autohaus fügt außerdem eine Beschreibung hinzu, die einen Kontext zur Verwendungsweise des Objekts bietet, und definiert eine Verknüpfung zwischen seinem benutzerdefinierten Objekt und dem Standardkontaktobjekt, damit es Autos mit potenziellen Käufern verknüpfen kann. 

Nach das Datenmodell von CarSpot abgeschlossen ist, erstellt es das Objektschema, indem es eine POST-Anfrage an /crm/v3/schemas mit dem folgenden Anfragetext durchführt:alles

// Example POST request to https://api.hubspot.com/crm/v3/schemas { "name": "cars", "description": "Cars keeps track of cars currently or previously held in our inventory.", "labels": { "singular": "Car", "plural": "Cars" }, "primaryDisplayProperty": "model", "secondaryDisplayProperties": [ "make" ], "searchableProperties": [ "year", "make", "vin", "model" ], "requiredProperties": [ "year", "make", "vin", "model" ], "properties": [ { "name": "condition", "label": "Condition", "type": "enumeration", "fieldType": "select", "options": [ { "label": "New", "value": "new" }, { "label": "Used", "value": "used" } ] }, { "name": "date_received", "label": "Date received", "type": "date", "fieldType": "date" }, { "name": "year", "label": "Year", "type": "number", "fieldType": "number" }, { "name": "make", "label": "Make", "type": "string", "fieldType": "text" }, { "name": "model", "label": "Model", "type": "string", "fieldType": "text" }, { "name": "vin", "label": "VIN", "type": "string", "hasUniqueValue": true, "fieldType": "text" }, { "name": "color", "label": "Color", "type": "string", "fieldType": "text" }, { "name": "mileage", "label": "Mileage", "type": "number", "fieldType": "number" }, { "name": "price", "label": "Price", "type": "number", "fieldType": "number" }, { "name": "notes", "label": "Notes", "type": "string", "fieldType": "text" } ], "associatedObjects": [ "CONTACT" ] }

Nach dem Erstellen des Objektschemas achtet CarSpot darauf, das {objectTypeId}-Feld des neuen Objekts zu notieren, da es später zum Abrufen und Aktualisieren des Objekts verwendet wird. Sie können auch den {fullyQualifiedName}-Wert verwenden, wenn sie es vorziehen.

Erstellen eines benutzerdefinierten Objektdatensatzes

Mit dem erstellten benutzerdefinierten Objekt kann CarSpot jetzt Datensätze im Objekt für jedes Auto in seinem Bestand erstellen.

Es erstellt sein erstes Auto, indem es eine POST-Anfrage an /crm/v3/objects/2-3465404 mit dem folgenden Anfragetext durchführt:

// Example POST request to https://api.hubspot.com/crm/v3/objects/2-3465404 { "properties": { "condition": "used", "date_received": "1582416000000", "year": "2014", "make": "Nissan", "model": "Frontier", "vin": "4Y1SL65848Z411439", "color": "White", "mileage": "80000", "price": "12000", "notes": "Excellent condition. No accidents." } }

Die Antwort für diesen API-Aufruf sieht ungefähr so aus:Alles kopieren

// Example response body { "id": "181308", "properties": { "color": "White", "condition": "used", "make": "Nissan", "mileage": "80000", "model": "Frontier", "vin": "4Y1SL65848Z411439", "notes": "Excellent condition. No accidents.", "price": "12000", "year": "2014", "date_received": "1582416000000" }, "createdAt": "2020-02-23T01:44:11.035Z", "updatedAt": "2020-02-23T01:44:11.035Z", "archived": false }

Da der Datensatz erstellt ist, kann CarSpot den id-Wert verwenden, um das Auto später einem vorhandenen Kontakt zuzuordnen.

Wenn sie diesen Datensatz später zusammen mit bestimmten Eigenschaften abrufen möchten, können sie eine GET-Anfrage an https://api.hubapi.com/crm/v3/objects/2-3465404/181308?portalId=1234567&properties=year&properties=make&properties=model durchführen.

Zuordnen des benutzerdefinierten Objektdatensatzes zu einem anderen Datensatz

Mit der ID des neuen Fahrzeugdatensatzes (181308) und der ID eines anderen Datensatzes können Sie einen benutzerdefinierten Objektdatensatz einem Datensatz eines anderen Objekts zuordnen.

Um eine Zuordnung zu erstellen, führen Sie eine PUT-Anfrage an /crm/v3/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationType} durch. Wenn die Objektbeziehung bereits definiert ist, führen Sie eine GET-Anfrage an crm/v3/schemas/{objectType} durch, um den associationType-Wert zu bestimmen.

Beispielsweise kann CarSpot mit der Kontakt-ID 51 und dem Zuordnungstyp 75 den Fahrzeugdatensatz einem Kontakt zuordnen. Mithilfe der obigen IDs wird die Anfrage-URL wie folgt erstellt:

https://api.hubspot.com/crm/v3/objects/2-3465404/181308/associations/contacts/51/75

Definieren einer neuen Zuordnung

CarSpot möchte nun damit beginnen, die nach dem Verkauf geleisteten Dienstleistungen für seine Autos nachzuverfolgen. Dazu verwendet es HubSpot-Tickets, um alle durchgeführten Wartungsarbeiten zu protokollieren.

Um Verknüpfungen zwischen Autos und Tickets zu ermöglichen, erstellt es eine neue Zuordnung, indem es eine POST-Anfrage an /crm/v3/schemas/2-3465404/associations mit dem folgenden Anfragetext durchführt:

// Example POST request to https://api.hubspot.com/crm/v3/schemas/2-3465494/associations { "fromObjectTypeId": "2-3465404", "toObjectTypeId": "ticket", "name": "car_to_ticket" }

Die Antwort für diesen API-Aufruf sieht ungefähr so aus:Alles kopieren

// Example response { "id": "121", "createdAt": "2020-02-23T01:52:12.893826Z", "updatedAt": "2020-02-23T01:52:12.893826Z", "fromObjectTypeId": "2-3465404", "toObjectTypeId": "0-5", "name": "car_to_ticket" }

Wenn Sie eine neue Zuordnung zwischen zwei benutzerdefinierten Objekten erstellen, geben Sie die benutzerdefinierten Objekte mit ihrer objectTypeId im toObjectTypeId-Feld an. Bei Standardobjekten können Sie diese benennen oder folgende Werte verwenden: 

  • Kontakt: 0-1
  • Unternehmen: 0-2
  • Deal: 0-3
  • Ticket: 0-5

Definieren einer neuen Eigenschaft

Beim Nachverfolgen der Wartung erkennt CarSpot eine Möglichkeit, Wartungsdienste in Paketen zu bündeln. Um diese Wartungspakete in einzelnen Fahrzeugdatensätzen nachzuverfolgen, erstellt das Autohaus eine neue Enumerationseigenschaft, die die verfügbaren Pakete enthält.

Um eine neue Eigenschaft zu definieren, führt es eine POST-Anfrage an /crm/v3/properties/2-3465404 mit dem folgenden Anfragetext durch:

// Example POST request to https://api.hubspot.com/crm/v3/properties/2-3465404 { "groupName": "car_information", "name": "maintenance_package", "label": "Maintenance Package", "type": "enumeration", "fieldType": "select", "options": [ { "label": "Basic", "value": "basic" }, { "label": "Oil change only", "value": "oil_change_only" }, { "label": "Scheduled", "value": "scheduled" } ] }

Die Antwort für diesen API-Aufruf sieht ungefähr so aus:Alles kopieren

// Example response { "updatedAt": "2020-02-23T02:08:20.055Z", "createdAt": "2020-02-23T02:08:20.055Z", "name": "maintenance_package", "label": "Maintenance Package", "type": "enumeration", "fieldType": "select", "groupName": "car_information", "options": [ { "label": "Basic", "value": "basic", "displayOrder": -1, "hidden": false }, { "label": "Oil change only", "value": "oil_change_only", "displayOrder": -1, "hidden": false }, { "label": "Scheduled", "value": "scheduled", "displayOrder": -1, "hidden": false } ], "displayOrder": -1, "calculated": false, "externalOptions": false, "archived": false, "hasUniqueValue": false, "hidden": false, "modificationMetadata": { "archivable": true, "readOnlyDefinition": false, "readOnlyValue": false }, "formField": false }

Da jetzt die Eigenschaft erstellt ist, möchtet das Autohaus, dass sie in der Seitenleiste der einzelnen Fahrzeugdatensätze angezeigt wird, sodass die Informationen problemlos seinen Vertriebsmitarbeitern und Technikern zur Verfügung stehen. Dazu fügt CarSpot die Eigenschaft zu secondaryDisplayProperties hinzu, indem es eine PATCH-Anfrage an /crm/v3/schemas/2-3465404 mit dem folgenden Anfragetext durchführt: 

// Example PATCH request to https://api.hubspot.com/crm/v3/schemas/2-3465404 { "secondaryDisplayProperties": [ "maintenance_package" ] }

Die Antwort für diesen API-Aufruf sieht ungefähr so aus:Alles kopieren

// Example response { "id": "3465404", "createdAt": "2020-02-23T01:24:54.537Z", "updatedAt": "2020-02-23T02:12:24.175874Z", "labels": { "singular": "Car", "plural": "Cars" }, "requiredProperties": [ "year", "model", "vin", "make" ], "searchableProperties": [ "year", "model", "vin", "make" ], "primaryDisplayProperty": "model", "secondaryDisplayProperties": [ "maintenance_package" ], "portalId": 1234567, "name": "car" }

Wenn nun ein Techniker einen Kontaktdatensatz öffnet, dem ein Fahrzeug zugeordnet ist, wird die Eigenschaft auf der Karte für benutzerdefinierte Objekte in der Seitenleiste angezeigt:

Screen Shot 2020-03-06 at 11.08.41 AM

Da CarSpot weiterhin HubSpot nutzt, findet es wahrscheinlich noch mehr Möglichkeiten, dieses benutzerdefinierte Objekt mithilfe der HubSpot-API zu verfeinern und zu erweitern. Es könnte sich sogar dazu entschließen, dynamische Seiten mithilfe seiner benutzerdefinierten Objektdaten zu erstellen.

War dieser Artikel hilfreich?
Dieses Formular dient dazu, Feedback zu unserer Entwicklerdokumentation zu sammeln. Wenn Sie uns Ihre Meinung zu HubSpot-Produkten mitteilen möchten, teilen Sie diese bitte im Ideenforum der Community.