API du CRM | Associations v4

​

HubSpot a défini des types d’association

• Principale : l’entreprise principale à laquelle l’autre fiche d’informations est associée. Les associations principales peuvent être utilisées dans les outils HubSpot tels que les listes et les workflows. Pour les fiches d’informations contenant plusieurs entreprises associées, cette API prend en charge la modification de l’entreprise considérée comme principale.
• Sans libellé : un type d’association ajouté lorsqu’une fiche d’informations de contact, d’entreprise, de transaction, de ticket ou d’objet personnalisé est associée. Ce type indique qu’une association existe et sera toujours renvoyée dans les réponses avec une valeur de libellé de null. Lorsqu’une fiche d’informations dispose d’une association principale ou d’un libellé d’association personnalisé, ces types seront répertoriés avec le type d’association sans libellé.

​

Libellés simples ou jumelés

• Unique : un libellé qui s’applique aux deux fiches d’informations de la relation. Par exemple : Ami ou Collègue.
• Jumelé : une paire de libellés pour les cas où des mots différents sont utilisés pour décrire chaque aspect de la relation des fiches d’informations associées. Par exemple : Parent et Enfant ou Employeur et Employé. Pour créer des libellés appariés, vous devez inclure le champ inverseLabel dans votre demande pour nommer le deuxième libellé de la paire.

​

Créer des types d’association

• nom : le nom interne du type d’association. Cette valeur ne peut pas comprendre de traits d’union ni commencer par un caractère numérique.
• libellé : le nom du libellé d’association tel qu’il apparaît dans HubSpot.
• inverseLabel (libellés jumelés uniquement) : le nom du deuxième libellé de la paire de libellés.

​

Récupérer les types d’association

• catégorie : si le type d’association a été créé par HubSpot (HUBSPOT_DEFINED) ou par un utilisateur (USER_DEFINED).
• **typeId: ** l’ID numérique pour ce type d’association. Ceci est utilisé pour définir un libellé lors de l’association de fiches d’informations. Consultez cette liste pour toutes les valeurs typeId définies par HubSpot.
• libellé : le libellé alphanumérique. Il s’agit de la valeur null du type d’association sans libellé.

​

Associer des fiches d’informations

​

Associer des fiches d’informations sans libellé

• fromObjectType** :** l’ID de l’objet que vous associez. Pour trouver les valeurs d’ID, consultez cette liste d’ID de types d’objet, ou pour les contacts, les entreprises, les transactions, les tickets et les notes, vous pouvez utiliser le nom d’objet (par exemple : contact, company).
• fromObjectId** :** l’ID de la fiche d’informations à associer.
• toObjectType** :** l’ID de l’objet auquel vous associez la fiche d’informations. Pour trouver les valeurs d’ID, consultez cette liste d’ID de types d’objet, ou pour les contacts, les entreprises, les transactions, les tickets et les notes, vous pouvez utiliser le nom d’objet (par exemple : contact, company).
• toObjectId** :** l’ID de la fiche d’informations à associer.

​

Associer des fiches d’informations avec libellé

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

​

Définir et gérer des limites d’association

​

Créer ou mettre à jour des limites d’association

• Pour créer des limites, effectuez une demande POST à crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create.
• Pour mettre à jour les limites existantes, effectuez une demande POST à crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update.

//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
    }
  ]
}

​

Récupérer les limites d’association

• Pour lire toutes les limites d’association définies, effectuez une demande GET à /crm/v4/associations/definitions/configurations/all. Cela renverra des limites d’association personnalisées définies pour tous les objets.
• Pour lire les limites d’association entre deux objets spécifiques, effectuez une demande GET à /crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}.

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

​

Supprimer les limites d’association

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

​

Rapport sur l’utilisation fréquente des associations

​

Valeurs d’ID de type d’association

​

Associations v1 (hérité)