Entreprises 

PrésentationPoints de terminaison

Dans HubSpot, les entreprises stockent des informations sur les organisations qui interagissent avec elles. Les points de terminaison des entreprises vous permettent de créer et de gérer des fiches d'informations d'entreprise ainsi que de synchroniser des données d'entreprise 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.

Créer des entreprises

Pour créer de nouvelles entreprises, effectuez une demande POST à /crm/v3/objects/companies.

Dans votre demande, 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 demande : 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 demande GET à /crm/v3/properties/companies. Découvrez-en davantage sur l'API des propriétés.

Remarque : Si vous avez inclus 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 une nouvelle entreprise, votre demande peut ressembler à ce qui suit :

///Example request body { "properties": { "name": "HubSpot", "domain": "hubspot.com", "city": "Cambridge", "industry": "Technology", "phone": "555-555-555", "state": "Massachusetts", "lifecyclestage": "51439524" } }

Associations

Lorsque vous créez une nouvelle entreprise, vous pouvez également associer l'entreprise à des fiches d'informations ou activités existantes. Dans l'objet d'association, ajoutez les champs suivants :

Use this table to describe parameters / fields
ParameterDescription
toObjectId

L'ID de la fiche d'informations ou de l'activité à laquelle vous souhaitez associer l'entreprise.

associationTypeId

Un identifiant unique pour indiquer le type d'association entre l'entreprise 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 GET à /crm/v4/associations/{fromObjectType}/{toObjectType}/labels. Découvrez-en davantage sur l'API des associations.

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 une nouvelle entreprise à un contact et une adresse e-mail existants, votre demande ressemblerait à ce qui suit :

///Example request body { "properties": { "name": "HubSpot", "domain": "hubspot.com", "city": "Cambridge", "industry": "Technology", "phone": "555-555-555", "state": "Massachusetts", "lifecyclestage": "51439524" }, "associations": [ { "to": { "id": 101 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 280 } ] }, { "to": { "id": 556677 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 185 } ] }] }

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 demande GET à /crm/v3/objects/companies/{companyId}.
  • Pour demander une liste de toutes les entreprises, effectuez une demande GET à /crm/v3/objects/companies.

Pour ces points de terminaison, vous pouvez inclure les paramètres suivants dans l'URL de la requête : 

Use this table to describe parameters / fields
ParameterDescription
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 demande 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.

Pour le point de terminaison de lecture par lot, vous pouvez également utiliser le paramètre 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'identifiant dans la demande 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 demande peut ressembler à ce qui suit :

///Example request body with record ID { "properties": [ "name", "domain" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }
///Example request body with a unique value property { "properties": [ "name", "domain" ], "idProperty": "uniquepropertyexample", "inputs": [ { "id": "abc" }, { "id": "def" } ] }

Pour récupérer des entreprises avec des valeurs actuelles et historiques pour une propriété, votre demande pourrait ressembler à :

///Example request body with record ID (current and historical values) { "propertiesWithHistory": [ "name" ], "inputs": [ { "id": "56789" }, { "id": "23456" } ] }

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 demande PATCH à /crm/v3/objects/companies/{companyId} et incluez les données que vous souhaitez mettre à jour.

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 demande PUT à /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 demande GET à/crm/v4/associations/{fromObjectType}/{toObjectType}/labels. 

Découvrez-en davantage sur l'association de fiches d'informations avec l'API des associations.

Supprimer une association

Pour supprimer une association entre une entreprise et une fiche d'informations ou une activité, effectuez une demande DELETE à 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 champ hs_pinned_engagement_id dans votre demande. 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 demande peut ressembler à :

///Example request body PATCH /crm/v3/objects/companies/{companyId} { "properties": { "hs_pinned_engagement_id": 123456789 } }

Vous pouvez également créer une entreprise, l'associer à une activité existante et épingler l'activité dans la même demande. Par exemple :

///Example request body POST /crm/v3/objects/companies { "properties": { "domain": "example.com", "name": "Example Company", "hs_pinned_engagement_id": 123456789 }, "associations": [ { "to": { "id": 123456789 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 189 }] }] }

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 demande DELETE à /crm/v3/objects/companies/{companyId}.

Pour en savoir plus sur la suppression d'entreprises par lots, cliquez sur l'onglet Points de terminaison en haut de cet article.

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é.