Associations v3

Vue d'ensemblePoints de terminaison d'associationPoints de terminaison du schéma d'association

There is a new version of the Associations API that adds the ability to create multiple types of associations between two object types.

Les associations représentent les relations entre les objets et les activités dans le CRM de HubSpot. Vous pouvez utiliser les points de terminaison des associations pour créer, récupérer ou supprimer des associations en masse. Vous pouvez associer les objets ou engagements suivants via l'API des associations :

  • Contacts
  • Entreprises
  • Transactions
  • Tickets
  • Appels
  • Devis
  • Lignes de produit
  • Réunions
  • Produits
  • Soumissions de feedbacks
  • Objets personnalisés (le nom de votre objet)

Découvrez-en davantage sur les API d'objets, de fiches d'informations, de propriétés et d'associations dans le guide Comprendre le CRM. Pour plus d'informations générales sur les objets et les fiches d'informations dans HubSpot, découvrez comment gérer votre base de données CRM.

Please note: this API doesn't support parent-child associations or special contact-to-company associations. Learn more about how you can use these associations with the previous version of the associations API.

Définitions des associations

Les associations sont définies par un type d'objet et un sens. Les types d'associations sont unidirectionnels. Par conséquent, vous devrez utiliser une autre définition en fonction du type d'objet initial. Par exemple :

  • Pour voir tous les tickets associés à un contact, vous définirez l'association avec l'URL de demande /crm/v3/associations/Contacts/Tickets/batch/read et identifierez le contact dans le corps de la demande par son objectId. Dans cet exemple, Contacts est le fromObjectType et Tickets est le toObjectType.
  • Pour associer une fiche d'informations de contact à une fiche d'informations d'objet personnalisé, où votre objet personnalisé est Animaux de compagnie, vous définirez l'association avec l'URL de demande /crm/v3/associations/Animaux de compagnie/Contacts/batch/create et identifierez les fiches d'informations de contact et d'animaux de compagnie que vous souhaitez associer dans le corps de la demande par leurs objectIds. Dans cet exemple, Animaux de compagnie est le fromObjectType et Contacts est le toObjectType.

Pour afficher tous les types d'association définis entre les objets, effectuez une demande GET vers /crm/v3/associations/{fromObjectType}/{toObjectType}/types.

Créer des associations

Pour associer des fiches d'informations dans HubSpot, effectuez une demande POST vers /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create. Dans votre demande, incluez les valeurs id des fiches d'informations que vous souhaitez associer ainsi que la valeur type de l'association à laquelle appartiennent les fiches d'informations.

Par exemple, pour associer des contacts à des entreprises, l'URL de votre demande sera /crm/v3/associations/Contacts/Companies/batch/create, et votre demande ressemblera à ce qui suit :

///Example request body { "inputs": [ { "from": { "id": "53628" }, "to": { "id": "12726" }, "type": "contact_to_company" } ] }

Récupérer des associations

Pour récupérer des fiches d'informations associées, effectuez une demande POST vers /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read. Dans votre demande, vous pouvez inclure la valeur id d'une fiche d'informations spécifique pour fromObjectType. Dans votre réponse, vous recevrez les valeurs id de toutes les fiches d'informations associées toObjectType.

Par exemple, pour récupérer toutes les transactions associées à une entreprise, l'URL de votre demande ressemblera à /crm/v3/associations/Companies/Deals/batch/read. Votre réponse inclura les valeurs id de toutes les transactions associées.

Supprimer des associations

Pour supprimer les associations entre des fiches d'informations, effectuez une demande POST vers /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive.

Cet article vous a-t-il été utile ?
Ce formulaire est destiné à recueillir les avis sur la documentation pour les développeurs. Si vous souhaitez faire part de votre avis sur les produits HubSpot, veuillez le partager sur le forum des idéesde la communauté.