Les fiches d’informations de contact stockent des informations sur des personnes. Les points de terminaison des contacts vous permettent de gérer ces données et de les synchroniser entre HubSpot et d’autres systèmes.
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).
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. |
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. |
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. |
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.
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 :
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. |
https://api.hubspot.com/crm/v3/objects/notes/17147287858/associations/contact/581751/202
DELETE
à la même URL que ci-dessus :
/crm/v3/objects/notes/{noteId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
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.
DELETE
à /crm/v3/objects/notes/{noteId}
.
Pour en savoir plus sur la suppression des notes, consultez la documentation de référence.