Contacts
Dans HubSpot, les contacts stockent des informations sur les personnes qui interagissent avec votre entreprise. Les points de terminaison des contacts vous permettent de créer et de gérer des fiches d'informations de contact ainsi que de synchroniser des données de contact entre HubSpot et d'autres systèmes.
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.
Pour créer de nouveaux contacts, effectuez une demande POST à /crm/v3/objects/contacts.
Dans votre demande, incluez les données de votre contact dans un objet de propriétés. Vous pouvez également ajouter un objet d'association pour associer votre nouveau contact à des fiches d'informations existantes (par exemple, des entreprises ou des transactions) ou à des activités (par exemple, des réunions ou des notes).
Les détails du contact sont stockés dans des propriétés de contact. Il existe des propriétés de contact HubSpot par défaut, mais vous pouvez également créer des propriétés personnalisées.
Lorsque vous créez un nouveau contact, vous devez inclure au moins une des propriétés suivantes dans votre demande : email, firstname ou lastname. Il est recommandé de toujours inclure email, car les adresses e-mail constituent le principal identifiant unique pour éviter les contacts en double dans HubSpot.
Pour afficher toutes les propriétés disponibles, vous pouvez récupérer une liste des propriétés de contact de votre compte en effectuant une demande GET à /crm/v3/properties/contacts. Découvrez-en davantage sur l'API des propriétés.
lifecyclestage dans votre demande, les valeurs doivent faire référence au nom interne de la phase du cycle de vie. Les noms internes des phases par défaut sont des valeurs textuelles et ne changent pas, même si vous modifiez le libellé de la phase (par exemple, subscriber ou marketingqualifiedlead). Les noms internes des phases personnalisées sont des valeurs numériques. Vous pouvez trouver l'ID interne d'une phase dans vos paramètres de phase du cycle de vie ou en récupérant la propriété de phase du cycle de vie via l'API.
Par exemple, pour créer un nouveau contact, votre demande peut ressembler à ce qui suit :
Lorsque vous créez un nouveau contact, vous pouvez également associer le contact à des fiches d'informations ou activités existantes. Dans l'objet d'association, ajoutez les champs suivants :
| Parameter | Description |
|---|---|
toObjectId
| L'ID de la fiche d'informations ou de l'activité à laquelle vous souhaitez associer le contact. |
associationTypeId
| Un identifiant unique pour indiquer le type d'association entre le contact et l'autre objet ou activité. Les types d'association par défaut sont répertoriés ici, ou vous pouvez récupérer la valeur en effectuant une demande |
Vous pouvez également inclure le champ label pour attribuer un libellé d'association défini qui décrit l'association. Découvrez-en davantage sur l'association de fiches d'informations via l'API des associations.
Par exemple, pour associer un nouveau contact à une entreprise et une adresse e-mail existantes, votre demande ressemblerait à ce qui suit :
Vous pouvez récupérer des contacts individuellement ou par lots. Pour récupérer un contact individuel, effectuez une demande GET à /crm/v3/objects/contacts/{contactId}.
Pour demander une liste de tous les contacts, effectuez une demande GET à /crm/v3/objects/contacts.
Pour les deux points de terminaison, vous pouvez inclure les paramètres suivants dans l'URL de la requête :
| Parameter | Description |
|---|---|
properties
| Une liste séparée par des virgules des propriétés à renvoyer dans la réponse. Si le contact demandé n'a pas de valeur pour une propriété, il n'apparaîtra pas dans la réponse. |
associations
| Une liste séparée par des virgules des objets pour lesquels récupérer les ID associés. Les associations spécifiées qui n'existent pas ne seront pas renvoyées dans la réponse. Découvrez-en davantage sur l'API des associations. |
Par exemple, pour récupérer des contacts avec leurs adresses e-mail et les entreprises associées, l'URL de votre demande ressemblerait à : https://api.hubspot.com/crm/v3/objects/contacts?properties=email&associations=companies.
Pour en savoir plus sur la récupération de contacts par lots, cliquez sur l'onglet Points de terminaison en haut de cet article.
Vous pouvez mettre à jour des contacts individuellement ou par lots. Pour des contacts existants, l'adresse e-mail et l'ID du contact sont des valeurs uniques. Vous pouvez donc utiliser email ou id pour mettre à jour le contact via l'API.
Pour mettre à jour un contact individuel avec son ID de contact, effectuez une demande PATCH à /crm/v3/objects/contacts/{contactId} et incluez les données que vous souhaitez mettre à jour.
idProperty n'apparaît pas dans l'onglet Points de terminaison en raison de limitations techniques, mais il peut être utilisé pour les contacts exclusivement avec l'email. Pour utiliser une adresse e-mail comme identifiant unique, définissez idProperty comme adresse e-mail et saisissez l'adresse e-mail à la place de l'identifiant du contact. Cela doit être défini en tant que paramètre de requête et non pas ajouté au corps de la requête.
Pour associer un contact à d'autres fiches d'informations CRM ou à une activité, effectuez une demande PUT à /crm/v3/objects/contacts/{contactId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.
associationTypeId, reportez-vous à cette liste de valeurs par défaut ou effectuez une demande GET à/crm/v4/associations/{fromObjectType}/{toObjectType}/labels.
Découvrez-en davantage sur l'API des associations.
Pour supprimer une association entre un contact et une fiche d'informations ou une activité, effectuez une demande DELETE à l'URL suivante : /crm/v3/objects/contacts/{contactID}/associations/{toObjectType}/{toObjectId}/{associationTypeId}.
Vous pouvez supprimer des contacts individuellement ou par lots, ce qui placera le contact dans la corbeille dans HubSpot. Vous pourrez ensuite restaurer la transaction dans HubSpot.
Pour supprimer un contact avec son ID, effectuez une demande DELETE à /crm/v3/objects/contacts/{contactId}.
Pour en savoir plus sur la suppression de contacts par lots, cliquez sur l'onglet Points de terminaison en haut de cet article.
Batch operations for creating, updating, and archiving are limited to batches of 100. There are also limits for contacts and form submissions.
Merci d'avoir partagé votre avis.