CRM-API | Zuordnungen v4

​

Von HubSpot definierte Zuordnungstypen

• Primär: das Hauptunternehmen, dem der andere Datensatz zugeordnet ist. Primäre Zuordnungen können in HubSpot-Tools wie Listen und Workflows verwendet werden. Für Datensätze mit mehreren zugeordneten Unternehmen unterstützt diese API das Ändern, welches Unternehmen als primäres Unternehmen gilt.
• Ohne Label: ein Zuordnungstyp, der hinzugefügt wird, wenn ein beliebiger Kontakt-, Unternehmens-, Deal-, Ticket- oder benutzerdefinierter Objektdatensatz zugeordnet wird. Dieser Typ gibt an, dass eine Zuordnung vorhanden ist, und wird immer in Antworten mit einem Label-Wert von null zurückgegeben. Wenn ein Datensatz über eine primäre Zuordnung oder ein benutzerdefiniertes Zuordnungslabel verfügt, werden diese Typen neben dem nicht benannten Zuordnungstyp aufgeführt.

​

Einzelne vs. gepaarte Labels

• Einzeln: ein Label, das für beide Datensätze in der Beziehung gilt. Zum Beispiel: Freund oder Kollege.
• Paar: ein Label-Paar, wenn unterschiedliche Wörter verwendet werden, um jede Seite der Beziehung zwischen den zugeordneten Datensätzen zu beschreiben. Zum Beispiel: Übergeordnet und Untergeordnet oder Arbeitgeber und Arbeitnehmer. Um gepaarte Label zu erstellen, müssen Sie das inverseLabel-Feld in Ihre Anfrage aufnehmen, um das zweite Label im Paar zu benennen.

​

Zuordnungstypen erstellen

• name: der interne Name des Zuordnungstyps. Dieser Wert darf keine Bindestriche enthalten oder mit einem numerischen Zeichen beginnen.
• Label : der Name des Zuordnungslabels, wie in HubSpot angezeigt.
• inverseLabel (Nur gepaarte Labels): der Name des zweiten Labels im Label-Paar.

​

Zuordnungstypen abrufen

• category: Gibt an, ob der Zuordnungstyp von HubSpot (HUBSPOT_DEFINED) oder von einem Benutzer (USER_DEFINED) erstellt wurde.
• typeId: die numerische ID für diesen Zuordnungstyp. Dies wird verwendet, um beim Zuordnen von Datensätzen ein Label festzulegen. In dieser Liste finden Sie alle von HubSpot definierten typeId-Werte.
• Label: das alphanumerische Label. Dies ist dann null für den Zuordnungstyp ohne Label.

​

Datensätze verknüpfen

​

Datensätze ohne Label zuordnen

• fromObjectType: die ID des Objekts, das Sie zuordnen. Die ID-Werte finden Sie in dieser Liste der Objekttyp-IDs, oder für Kontakte, Unternehmen, Deals, Tickets und Notizen können Sie den Objektnamen verwenden (z. B contact, company).
• fromObjectId: die ID des zuzuordnenden Datensatzes.
• toObjectType: die ID des Objekts, dem Sie den Datensatz zuordnen. Die ID-Werte finden Sie in dieser Liste der Objekttyp-IDs, oder für Kontakte, Unternehmen, Deals, Tickets und Notizen können Sie den Objektnamen verwenden (z. B contact, company).
• toObjectId: die ID des Datensatzes, der zugeordnet werden soll.

​

Datensätze einem Label zuordnen

/// Example request body
[
  {
    "associationCategory": "USER_DEFINED",
    "associationTypeId": 36
  }
]

​

Zuordnungslimits festlegen und verwalten

​

Zuordnungslimits erstellen oder aktualisieren

• Um Limits zu erstellen, führen Sie eine POST-Anfrage an crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create durch.
• Um bestehende Limits zu aktualisieren, führen Sie eine POST-Anfrage an crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update durch.

//Example request POST crm/v4/associations/definitions/configurations/deal/contact/batch/create
{
  "inputs": [
    {
      "category": "HUBSPOT_DEFINED",
      "typeId": 3,
      "maxToObjectIds": 5
    },
    {
      "category": "USER_DEFINED",
      "typeId": 35,
      "maxToObjectIds": 1
    }
  ]
}

​

Zuordnungslimits abrufen

• Um alle definierten Zuordnungslimits zu lesen, führen Sie eine GET-Anfrage an/crm/v4/associations/definitions/configurations/all durch. Dadurch werden benutzerdefinierte Zuordnungslimits zurückgegeben, die für alle Objekte definiert sind.
• Um Zuordnungslimits zwischen zwei bestimmten Objekten zu lesen, führen Sie eine GET-Anfrage an /crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType} durch.

//Example response GET crm/v4/associations/definitions/configurations/deal/contact
{
  "results": [
    {
      "category": "HUBSPOT_DEFINED",
      "typeId": 3,
      "userEnforcedMaxToObjectIds": 5,
      "label": null
    }
  ]
}

​

Zuordnungslimits löschen

//Example request POST crm/v4/associations/definitions/configurations/deal/contact/batch/purge
{
  "inputs": [
    {
      "category": "USER_DEFINED",
      "typeId": 35
    }
  ]
}

​

Zu hoher Zuordnungsnutzung berichterstatten

​

ID-Werte des Zuordnungstyps

​

v1 Zuordnungen (alt)