Engagements | Notes - HubSpot docs

Run in Postman

Exigences de portée

Vous pouvez enregistrer des notes sur des fiches d’informations du CRM pour ajouter des informations à la chronologie de la fiche d’informations ou associer une pièce jointe à une fiche d’informations. Par exemple, si vous avez besoin de garder une trace d’une conversation hors ligne que vous avez eue avec un contact, vous pouvez ajouter une note à sa fiche d’informations de contact avec les détails et les documents associés à la conversation. Les autres utilisateurs pourront alors consulter et référencer cette note. Vous pouvez gérer des notes soit dans HubSpot soit via l’API de notes. Ci-dessous, découvrez les méthodes de base pour gérer les notes via l’API. Vous pouvez consulter tous les points de terminaison disponibles dans la documentation de référence.

Créer une note

Pour créer une note, effectuez une requête POST à /crm/v3/objects/notes. Dans le corps de la requête, ajoutez les détails de notes dans un objet properties. Vous pouvez également ajouter un objet d’association pour associer votre nouvelle note à une fiche d’informations existante (par exemple, des contacts ou des entreprises).

Propriétés

Dans l’objet de propriété, vous pouvez inclure les champs suivants :

Champ	Description
`hs_timestamp`	Obligatoire. Ce champ indique l’heure de création de la note et détermine où se trouve la note sur la chronologie de la fiche d’informations. Vous pouvez utiliser soit un horodatage Unix en millisecondes, soit un format UTC.
`hs_note_body`	Le contenu du texte d’une note, limité à 65 536 caractères.
`hubspot_owner_id`	L’ID du propriétaire associé à la note. Ce champ détermine l’utilisateur listé comme le créateur d’une note sur la chronologie de la fiche d’informations dans HubSpot.
`hs_attachment_ids`	Les ID des pièces jointes de la note. Les ID de pièces jointes multiples sont séparés par un point-virgule.

Associations

Pour créer et associer une note à des fiches d’informations existantes, incluez un objet d’association dans votre requête. Par exemple, pour créer une note et l’associer à une entreprise et à une transaction, votre corps de requête peut ressembler à ce qui suit :

// Example POST request to https://api.hubspot.com/crm/v3/objects/notes
{
  "properties": {
    "hs_timestamp": "2021-11-12T15:48:22Z",
    "hs_note_body": "Spoke with decision maker Carla. Attached the proposal and draft of contract.",
    "hubspot_owner_id": "14240720",
    "hs_attachment_ids": "24332474034;24332474044"
  },
  "associations": [
    {
      "to": {
        "id": 301
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 190
        }
      ]
    },
    {
      "to": {
        "id": 401
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 214
        }
      ]
    }
  ]
}

Dans l’objet d’association, vous devez ajouter les éléments suivants :

Champ	Description
`to`	La fiche d’informations à laquelle vous souhaitez associer la note, en fonction de sa valeur unique `id`.
`types`	Le type d’association entre la note et la fiche d’informations. 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.

Pour en savoir plus sur la création de notes par lots, consultez la documentation de référence.

Récupérer des notes

Vous pouvez récupérer des notes individuellement ou par lots. Pour récupérer une note individuelle, effectuez une requête GET à /crm/v3/objects/notes/{noteId}. Pour demander une liste de toutes les notes, effectuez une requête GET à /crm/v3/objects/notes. Pour les deux points de terminaison, vous pouvez inclure les paramètres suivants dans l’URL de la requête :

Paramètre	Description
`properties`	Une liste séparée par des virgules des propriétés à renvoyer dans la réponse. Si la note 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 types d’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 notes avec leur contenu textuel et tout ID de contact associé, l’URL de votre requête peut ressembler à ce qui suit : https://api.hubapi.com/crm/v3/objects/notes?limit=10&properties=hs_note_body&associations=contact&archived=false. Pour en savoir plus sur la récupération d’un lot de notes par identifiant interne ou par valeur de propriété unique, consultez la documentation de référence.

Mettre à jour les notes

Vous pouvez mettre à jour des notes individuellement ou par lots. Pour mettre à jour une note individuelle par son ID de note, effectuez une requête PATCH à /crm/v3/objects/notes/{noteId}. Dans le corps de la requête, incluez les propriétés de note que vous souhaitez mettre à jour :

// Example PATCH request to https://api.hubspot.com/crm/v3/objects/notes/{noteID}
{
  "properties": {
    "hs_note_body": "Spoke with decision maker Carla.",
    "hs_attachment_ids": "24332474034;24332474044"
  }
}

HubSpot ignorera les valeurs des propriétés inexistantes ou en lecture seule. Pour effacer une valeur de propriété, passez une chaîne vide comme valeur de propriété dans le corps de la requête. Pour en savoir plus sur la mise à jour des notes par lots, consultez la documentation de référence.

Associer des notes existantes à des fiches d’informations

Pour associer une note à d’autres fiches d’informations du CRM, comme un contact, effectuez une requête PUT à /crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}. L’URL de la requête contient les champs suivants :

Champ	Description
`noteId`	L’ID de la note
`toObjectType`	Le type d’objet auquel vous souhaitez associer la note (par exemple, contact ou entreprise)
`toObjectId`	L’ID de la fiche d’informations avec laquelle vous souhaitez associer la note.
`associationTypeId`	Un identifiant unique pour indiquer le type d’association entre la note et l’autre objet. L’ID peut être représenté numériquement ou en snake case (ex : `note_to_contact`). Vous pouvez récupérer la valeur via l’API des associations.

Par exemple, l’URL de votre requête peut ressembler à ce qui suit : https://api.hubspot.com/crm/v3/objects/notes/17147287858/associations/contact/581751/202

Supprimer une association

Pour supprimer une association entre une note et une fiche d’informations, faites une requête DELETE à la même URL que ci-dessus : /crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}

Épingler une note sur une fiche d’informations

Vous pouvez épingler une note sur une fiche d’informations afin qu’elle reste en haut de la chronologie de la fiche d’informations. La note doit déjà être associée à la fiche d’informations avant d’être épinglée, et vous ne pouvez épingler qu’une seule activité par fiches d’informations. Pour épingler une note, incluez l’id de la note dans le champ hs_pinned_engagement_id lors de la création ou de la mise à jour d’une fiche d’informations via les API objet. Découvrez-en davantage sur l’utilisation des API d’entreprises , de contacts, de transactions, de tickets et d’objets personnalisés.

Supprimer des notes

Vous pouvez supprimer des notes individuellement ou par lots, ce qui placera la note dans la corbeille dans HubSpot. Vous pouvez ensuite restaurer la note à partir de la chronologie des fiches d’informations. Pour supprimer une note individuelle par son ID de note, effectuez une requête DELETE à /crm/v3/objects/notes/{noteId}. Pour en savoir plus sur la suppression des notes, consultez la documentation de référence.

Compte et paramètres

Gestion des applications

Authentification

Automatisation

CMS

Préférences de communication

Conversations

CRM

Data Studio

Événements

Fichiers

Marketing

Rendez-vous

Chiffre d'affaires

Webhooks

Journal des webhooks

Engagements | Notes

Run in Postman

Créer une note

Propriétés

Associations

Récupérer des notes

Mettre à jour les notes

Associer des notes existantes à des fiches d’informations

Supprimer une association

Épingler une note sur une fiche d’informations

Supprimer des notes

Run in Postman

​Créer une note

​Propriétés

​Associations

​Récupérer des notes

​Mettre à jour les notes

​Associer des notes existantes à des fiches d’informations

​Supprimer une association

​Épingler une note sur une fiche d’informations

​Supprimer des notes

Créer une note

Propriétés

Associations

Récupérer des notes

Mettre à jour les notes

Associer des notes existantes à des fiches d’informations

Supprimer une association

Épingler une note sur une fiche d’informations

Supprimer des notes