Dernière modification : 8 octobre 2025
Run in Postman
Créer des entreprises
Pour créer de nouvelles entreprises, effectuez une requêtePOST
à /crm/v3/objects/companies
.
Dans votre requête, incluez les données de votre entreprise dans un objet de propriétés. Vous pouvez également ajouter un objet d’association pour associer votre nouvelle entreprise à des fiches d’informations existantes (par exemple, des contacts ou des transactions) ou à des activités (par exemple, des réunions ou des notes).
Propriétés
Les détails de l’entreprise sont stockés dans des propriétés d’entreprise. Il existe des propriétés d’entreprise HubSpot par défaut, mais vous pouvez également créer des propriétés personnalisées. Lorsque vous créez une nouvelle entreprise, vous devez inclure au moins une des propriétés suivantes dans votre requête :name
ou domain
. Il est recommandé de toujours inclure domain
, car les noms de domaine constituent le principal identifiant unique pour éviter les entreprises en double dans HubSpot. Si une entreprise possède plusieurs domaines, vous pouvez les ajouter via l’API en utilisant le champ hs_additional_domains
avec des points-virgules séparant chaque domaine. Par exemple : "hs_additional_domains" : "domain.com; domain2.com; domain3.com"
.
Pour afficher toutes les propriétés disponibles, vous pouvez récupérer une liste des propriétés d’entreprise de votre compte en effectuant une requête GET
à /crm/v3/properties/companies
. Découvrez-en davantage sur l’API des propriétés.
Remarque:
si vous avez incluslifecyclestage
dans votre requête, 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.- JSON
Associations
Lorsque vous créez une nouvelle entreprise, vous pouvez également associer l’entreprise à des fiches d’informations ou activités existantes dans un objet d’associations. Par exemple, pour associer une nouvelle entreprise à un contact et une adresse e-mail existants, votre requête ressemblerait à ce qui suit :- JSON
Paramètre | Description |
---|---|
to | La fiche d’informations ou l’activité à laquelle vous souhaitez associer l’entreprise, en fonction de sa valeur unique id . |
types | Le type d’association entre l’entreprise et la fiche d’informations/l’activité. Inclut la associationCategory et le associationTypeId . Les ID de types d’association par défaut sont répertoriés ici, ou vous pouvez récupérer la valeur des types d’associations personnalisés (c’est-à-dire les libellés) via l’API des associations. |
Récupérer des entreprises
Vous pouvez récupérer des entreprises individuellement ou par lots.- Pour récupérer une entreprise individuelle, effectuez une requête
GET
à/crm/v3/objects/companies/{companyId}
. - Pour demander une liste de toutes les entreprises, effectuez une requête
GET
à/crm/v3/objects/companies
.
Paramètre | Description |
---|---|
properties | Une liste séparée par des virgules des propriétés à renvoyer dans la réponse. Si l’entreprise demandée n’a pas de valeur pour une propriété, elle n’apparaîtra pas dans la réponse. |
propertiesWithHistory | Une liste séparée par des virgules des propriétés actuelles et historiques à renvoyer dans la réponse. Si l’entreprise demandée n’a pas de valeur pour une propriété, elle 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. |
- Pour récupérer un lot d’entreprises spécifiques par ID de fiche d’informations ou selon une propriété d’identifiant unique personnalisée, effectuez une requête
POST
àcrm/v3/objects/companies/batch/read
. Le point de terminaison du lot ne peut pas récupérer les associations. Découvrez comment lire par lots les associations avec l’API des associations.
idProperty
facultatif pour récupérer les entreprises en fonction d’une propriété d’identifiant unique personnalisée. Par défaut, les valeurs d’id
dans la requête font référence à l’ID de fiche d’informations (hs_object_id
), de sorte que le paramètre idProperty
n’est pas requis lors de la récupération par ID de fiche d’informations. Pour utiliser une propriété de valeur unique personnalisée pour récupérer des entreprises, vous devez inclure le paramètre idProperty
.
Par exemple, pour récupérer un lot d’entreprises, votre requête peut ressembler à ce qui suit :
Pour récupérer des entreprises avec des valeurs actuelles et historiques pour une propriété, votre requête pourrait ressembler à :
Mettre à jour des entreprises
Vous pouvez mettre à jour des entreprises individuellement ou par lots. Pour les entreprises existantes, l’ID de la fiche d’informations de l’entreprise est une valeur unique que vous pouvez utiliser pour mettre à jour l’entreprise via l’API. Pour mettre à jour une entreprise individuelle avec son ID d’entreprise, effectuez une requêtePATCH
à /crm/v3/objects/companies/{companyId}
et incluez les données que vous souhaitez mettre à jour.
Remarque:
Si vous mettez à jour la propriétélifecyclestage
, vous ne pouvez qu’avancer la valeur dans l’ordre des étapes. Pour rétrograder la phase du cycle de vie, vous devrez d’abord effacer la valeur de phase du cycle de vie existante de la fiche d’informations. La valeur peut être effacée manuellement, ou automatiquement via un workflow ou une intégration qui synchronise les données de contact.Associer des entreprises existantes à des fiches d’informations et activités
Pour associer une entreprise à d’autres fiches d’informations de CRM ou à une activité, effectuez une requêtePUT
à /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Pour récupérer la valeur
associationTypeId
, reportez-vous à cette liste de valeurs par défaut ou effectuez une requête GET
à /crm/v4/associations/{fromObjectType}/{toObjectType}/labels
.Supprimer une association
Pour supprimer une association entre une entreprise et une fiche d’informations ou une activité, effectuez une requêteDELETE
à l’URL suivante : /crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
.
Épingler une activité à une fiche d’informations d’une entreprise
Vous pouvez épingler une activité à une fiche d’informations d’une entreprise via l’API en incluant le champhs_pinned_engagement_id
dans votre requête. Dans le champ, incluez l’id
de l’activité à épingler, qui peut être récupéré via les API d’engagement. Vous pouvez épingler une activité par fiche d’informations, et l’activité doit déjà être associée à l’entreprise avant l’épinglage.
Pour définir ou mettre à jour l’activité épinglée d’une entreprise, votre requête peut ressembler à :
Supprimer des entreprises
Vous pouvez supprimer des entreprises individuellement ou par lots, ce qui placera l’entreprise dans la corbeille dans HubSpot. Vous pourrez ensuite restaurer l’entreprise dans HubSpot. Pour supprimer une entreprise avec son ID, effectuez une requêteDELETE
à /crm/v3/objects/companies/{companyId}
.
Pour en savoir plus sur la suppression d’entreprises par lots, consultez la documentation de référence.