Utilisez l’API d’engagement des réunions pour enregistrer et gérer les réunions dans les fiches d’informations CRM.
POST
à /crm/v3/objects/meetings
.
Dans le corps de la requête, ajoutez les détails de réunion dans un objet properties. Vous pouvez également ajouter un objet d’association pour associer votre nouvelle réunion à une fiche d’informations existante (par exemple, des contacts ou des entreprises).
Champ | Description |
---|---|
hs_timestamp | Obligatoire. Ce champ marque la date et l’heure auxquelles la réunion a eu lieu. Vous pouvez utiliser soit un horodatage Unix en millisecondes, soit un format UTC. Lorsque la valeur de la propriété est manquante, la valeur est définie par défaut sur hs_meeting_start_time. |
hs_meeting_title | Le titre du rendez-vous. |
hubspot_owner_id | L’ID du propriétaire associé à la réunion. Ce champ détermine l’utilisateur listé comme le créateur de réunion sur la chronologie de la fiche d’informations. |
hs_meeting_body | La description de la réunion |
hs_internal_meeting_notes | Les notes internes que vous prenez pour votre équipe au cours d’une réunion et qui ne sont pas incluses dans la description de la réunion des participants. |
hs_meeting_external_url | L’URL externe de la réunion pour l’événement du calendrier. Par exemple, il peut s’agir d’un lien vers Google Agenda ou un lien vers un calendrier Microsoft Outlook. |
hs_meeting_location | Lieu de la réunion. Il peut s’agir d’une adresse physique, d’une salle de conférence, d’un lien vers une vidéoconférence ou d’un numéro de téléphone. Cela apparaît sur l’invitation de calendrier sur le calendrier du participant. |
hs_meeting_start_time | La date et l’heure auxquelles la réunion commence. La valeur de cette propriété doit correspondre à la valeur de hs_timestamp . |
hs_meeting_end_time | La date et l’heure auxquelles la réunion se termine. |
hs_meeting_outcome | Le résultat de la réunion. Les valeurs de résultat sont : planifiée, terminée, replanifiée, désistement et annulée. |
hs_activity_type | Le type de réunion. Les options sont basées sur les types de réunion définis dans votre compte HubSpot. |
hs_attachment_ids | Les ID des pièces jointes de la réunion. 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 réunion, en fonction de sa valeur unique id . |
types | Le type d’association entre la réunion et la fiche d’informations. Inclut associationCategory et 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/meetings/{meetingId}
. Vous pouvez aussi 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. |
associations | Une liste séparée par des virgules des objets que voulez pour récupérer les ID des fiches d’informations associées. |
GET
à crm/v3/objects/meetings
. Vous pouvez inclure les paramètres suivants dans l’URL de la requête :
Paramètre | Description |
---|---|
limit | Le nombre maximum de résultats à afficher par page. |
properties | Une liste séparée par des virgules des propriétés à renvoyer. |
PATCH
à /crm/v3/objects/meetings/{meetingId}
.
Dans le corps de la requête, incluez les propriétés de réunion que vous souhaitez mettre à jour : Par exemple, votre corps de requête peut ressembler aux éléments suivants :
PUT
à /crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
. L’URL de la requête contient les champs suivants :
Champ | Description |
---|---|
meetingId | L’ID de la réunion. |
toObjectType | Le type d’objet auquel vous souhaitez associer la réunion (par exemple, contact ou entreprise). |
toObjectId | L’ID de la fiche d’informations avec laquelle vous souhaitez associer la réunion. |
associationTypeId | L’ID du type d’association entre la réunion et l’autre type d’objet. Vous pouvez récupérer cette valeur via l’API des associations. |
https://api.hubspot.com/crm/v3/objects/meetings/17612479134/associations/contact/104901/200
DELETE
à la même URL que ci-dessus :
/crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
id
de la réunion 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/meetings/{meetingId}
.
Pour en savoir plus sur la suppression par lots, consultez la documentation de référence.