Engagements | Réunions

Run in Postman

Exigences de portée

Utilisez l’API d’engagement des réunions pour enregistrer et gérer les réunions dans les fiches d’informations CRM. Vous pouvez enregistrer des activités de réunions soit dans HubSpot soit via l’API des réunions. Vous pouvez récupérer, mettre à jour ou supprimer les engagements de réunion enregistrés manuellement sur une fiche d’informations, planifiés à l’aide de l’outil réunions ou planifiés à l’aide de Google Agenda ou de l’intégration du calendrier Office 365. Découvrez ci-dessous les méthodes de base pour gérer les réunions via l’API. Pour connaître tous les points de terminaison disponibles et leurs exigences, consultez la documentation de référence.

Créer une réunion

Pour créer un engagement de réunion, effectuez une requête 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).

Propriétés

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

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.

Associations

Pour créer et associer une réunion à des fiches d’informations existantes, incluez un objet d’association dans votre requête. Par exemple, pour créer et associer une réunion à des contacts, votre requête peut ressembler à ce qui suit :

// Example request body
{
  "properties": {
    "hs_timestamp": "2021-03-23T01:02:44.872Z",
    "hubspot_owner_id": "11349275740",
    "hs_meeting_title": "Intro meeting",
    "hs_meeting_body": "The first meeting to discuss options",
    "hs_internal_meeting_notes": "These are the meeting notes",
    "hs_meeting_external_url": "https://Zoom.com/0000",
    "hs_meeting_location": "Remote",
    "hs_meeting_start_time": "2021-03-23T01:02:44.872Z",
    "hs_meeting_end_time": "2021-03-23T01:52:44.872Z",
    "hs_meeting_outcome": "SCHEDULED"
  },
  "associations": [
    {
      "to": {
        "id": 101
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 200
        }
      ]
    },
    {
      "to": {
        "id": 102
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 200
        }
      ]
    }
  ]
}

Les objets d’associations doivent inclure :

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.

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

Récupérer des réunions

Vous pouvez récupérer des réunions individuellement ou en lot. Pour en savoir plus sur la récupération des lots, consultez la documentation de référence. Pour récupérer une réunion individuelle par son ID d’appel, effectuez une requête 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.

Pour demander une liste de toutes les réunions, effectuez une requête 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.

Mettre à jour les réunions

Vous pouvez mettre à jour des réunions individuellement ou par lots. Pour mettre à jour une réunion individuelle par son ID d’appel, effectuez une requête 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 :

//Example PATCH request to https://api.hubspot.com/crm/v3/objects/meetings/{meetingId}
{
  "properties": {
     "hs_timestamp": "2019-10-30T03:30:17.883Z",
     "hubspot_owner_id": "11349275740",
     "hs_meeting_title": "Intro meeting",
     "hs_meeting_body": "The first meeting to discuss options",
     "hs_internal_meeting_notes": "These are the meeting notes",
     "hs_meeting_external_url":
     "https://Zoom.com/0000",
     "hs_meeting_location": "Remote",
     "hs_meeting_start_time": "2021-03-23T01:02:44.872Z",
     "hs_meeting_end_time": "2021-03-23T01:52:44.872Z",
     "hs_meeting_outcome": "SCHEDULED"
  }
}'

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 par lots, consultez la documentation de référence.

Associer des réunions existantes à des fiches d’informations

Pour associer une réunion à des fiches d’informations, comme un contact et ses entreprises associées, effectuez une requête 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.

Par exemple, l’URL de votre requête peut ressembler à ce qui suit : https://api.hubspot.com/crm/v3/objects/meetings/17612479134/associations/contact/104901/200

Supprimer une association

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

Épingler une réunion sur une fiche d’informations

Vous pouvez épingler une réunion sur une fiche d’informations afin qu’elle reste en haut de la chronologie de la fiche d’informations. La réunion 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 réunion, incluez l’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.

Supprimer des réunions

Vous pouvez supprimer des réunions individuellement ou par lots, ce qui placera la réunion dans la corbeille dans HubSpot. Vous pouvez ensuite restaurer la réunion à partir de la chronologie des fiches d’informations. Pour supprimer une réunion individuelle par son ID d’appel, effectuez une requête DELETE à /crm/v3/objects/meetings/{meetingId}. Pour en savoir plus sur la suppression par lots, 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 | Réunions

Run in Postman

Créer une réunion

Propriétés

Associations

Récupérer des réunions

Mettre à jour les réunions

Associer des réunions existantes à des fiches d’informations

Supprimer une association

Épingler une réunion sur une fiche d’informations

Supprimer des réunions

Run in Postman

​Créer une réunion

​Propriétés

​Associations

​Récupérer des réunions

​Mettre à jour les réunions

​Associer des réunions existantes à des fiches d’informations

​Supprimer une association

​Épingler une réunion sur une fiche d’informations

​Supprimer des réunions

Créer une réunion

Propriétés

Associations

Récupérer des réunions

Mettre à jour les réunions

Associer des réunions existantes à des fiches d’informations

Supprimer une association

Épingler une réunion sur une fiche d’informations

Supprimer des réunions