Interacciones | Reuniones

Run in Postman

Requisitos de ámbito

Usa la API de interacciones de reuniones para registrar y gestionar reuniones en los registros del CRM. Puedes registrar las actividades de las reuniones en HubSpot o a través de la API de reuniones. Puedes obtener, actualizar o eliminar las interacciones con reuniones registradas manualmente en un registro, programadas mediante la herramienta de reuniones o mediante la integración con el calendario de Google Calendar u Office 365. En este artículo encontrarás los métodos básicos de gestión de reuniones a través de la API. Para ver todos los endpoints disponibles y sus requisitos, consulta la documentación de referencia.

Crear una reunión

Para crear una interacción con una reunión, haz una solicitud POST a /crm/v3/objects/meetings. En el cuerpo de la solicitud, agrega los detalles de la reunión en el objeto propiedades. También puedes agregar un objeto asociaciones para asociar tu nueva reunión con un registro existente (por ejemplo, contactos, empresas).

Propiedades

En el objeto propiedades, puedes incluir los siguientes campos:

Campo	Descripción
`hs_timestamp`	Obligatorio. Este campo marca la fecha y hora en que ocurrió la reunión. Puedes usar una marca de tiempo Unix en milisegundos o en formato UTC. Si falta el valor de la propiedad, el valor predeterminado será `hs_meeting_start_time.`
`hs_meeting_title`	El título de la reunión.
`hubspot_owner_id`	El ID del propietario asociado con la reunión. Este campo determina el usuario que aparece como creador de la reunión en la cronología del registro.
`hs_meeting_body`	La descripción de la reunión.
`hs_internal_meeting_notes`	Las notas internas que tomas para tu equipo durante una reunión y que no están incluidas en la descripción de la reunión para los asistentes.
`hs_meeting_external_url`	La URL externa del evento del calendario. Por ejemplo, podría ser un enlace al calendario de Google o al de Microsoft Outlook.
`hs_meeting_location`	Dónde se lleva a cabo la reunión. El valor podría ser una dirección física, una sala de conferencias, un enlace de videoconferencia o un número de teléfono. Esta información aparece en la invitación de calendario del asistente.
`hs_meeting_start_time`	La fecha y hora en que comienza la reunión. El valor de esta propiedad debe coincidir con el valor de `hs_timestamp`.
`hs_meeting_end_time`	La fecha y hora en que termina la reunión.
`hs_meeting_outcome`	El resultado de la reunión. Los valores del resultado son programada, completada, reprogramada, sin asistencia y cancelada.
`hs_activity_type`	El tipo de reunión. Las opciones se basan en los tipos de reuniones definidos en tu cuenta de HubSpot.
`hs_attachment_ids`	Los ID de los archivos adjuntos de la reunión. Los ID de varios archivos adjuntos están separados por un punto y coma.

Asociaciones

Para crear y asociar una reunión con registros existentes, incluye un objeto de asociaciones en tu solicitud. Por ejemplo, para crear y asociar una reunión con contactos, tu solicitud puede ser similar a la siguiente:

// 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
        }
      ]
    }
  ]
}

El objeto asociaciones debe incluir:

Campo	Descripción
`to`	El registro que quieres asociar con la reunión, especificado por su valor `id` único.
`types`	El tipo de asociación entre la reunión y el registro. Incluye `associationCategory`y `associationTypeId`. Los ID de los tipos de asociación predeterminados se enumeran en este recurso, y también puedes obtener el valor de los tipos de asociación personalizados (es decir, etiquetas) a través de la API de asociaciones.

Obtén más información sobre la creación de reuniones por lotes consultando esta documentación de referencia.

Obtener reuniones

Puedes obtener la información de reuniones individualmente o en bloque. Obtén más información sobre la obtención de lotes consultando esta documentación de referencia. Para obtener la información de una reunión individual por su ID, haz una solicitud GET a /crm/v3/objects/meetings/{meetingId}. También puedes incluir los siguientes parámetros en la URL de la solicitud:

Parámetro	Descripción
`properties`	Una lista separada por comas de las propiedades que se devolverán.
`associations`	Una lista separada por comas de los objetos de los que quieres obtener los ID de registro asociados.

Para solicitar una lista de todas las reuniones, haz una solicitud GET a crm/v3/objects/meetings. Puedes incluir los siguientes parámetros en la URL de la solicitud:

Parámetro	Descripción
`limit`	El número máximo de resultados que se mostrarán por página.
`properties`	Una lista separada por comas de las propiedades que se devolverán.

Actualizar reuniones

Puedes actualizar las reuniones individualmente o en bloque. Para actualizar una reunión individual por su ID de reunión, haz una solicitud PATCH a /crm/v3/objects/meetings/{meetingId}. En el cuerpo de la solicitud, incluye las propiedades de la reunión que deseas actualizar. Por ejemplo, el cuerpo de la solicitud puede tener un aspecto similar a este:

//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 ignorará los valores de las propiedades de solo lectura e inexistentes. Para borrar el valor de una propiedad, pasa una cadena vacía para esa propiedad en el cuerpo de la solicitud. Obtén más información sobre la actualización en bloque consultando esta documentación de referencia.

Asociar reuniones existentes con registros

Para asociar una reunión con registros, como un contacto y sus empresas asociadas, haz una solicitud PUT a /crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}. La URL de la solicitud contiene los siguientes campos:

Campo	Descripción
`meetingId`	El ID de la reunión.
`toObjectType`	El tipo de objeto con el que quieres asociar la reunión (por ejemplo, un contacto o una empresa)
`toObjectId`	El ID del registro con el que quieres asociar la reunión.
`associationTypeId`	El ID del tipo de asociación entre la reunión y el otro tipo de objeto. Puedes obtener este valor a través de la API de asociaciones.

Por ejemplo, la URL de tu solicitud puede tener un aspecto similar al siguiente: https://api.hubspot.com/crm/v3/objects/meetings/17612479134/associations/contact/104901/200

Eliminar una asociación

Para eliminar una asociación entre una reunión y un registro, haz una solicitud DELETE en la misma URL que la anterior: /crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}

Fijar una reunión a un registro

Puedes fijar una reunión a un registro para que permanezca en la parte superior de la cronología del registro. La reunión ya debe estar asociada con el registro antes de fijarla, y solo puedes fijar una actividad por registro. Para fijar una reunión, incluye el id de la reunión en el campo hs_pinned_engagement_id al crear o actualizar un registro a través de las API de objetos. Obtén más información sobre el uso de las API de empresas, contactos, negocios, tickets, y objetos personalizados.

Eliminar reuniones

Puedes eliminar reuniones individualmente o por lotes, lo que agregará la reunión a la papelera de reciclaje en HubSpot. Más tarde podrás restaurar la reunión desde la cronología del registro. Para eliminar una reunión individual por su ID de reunión, haz una solicitud DELETE a /crm/v3/objects/meetings/{meetingId}. Para saber más sobre la eliminación por lotes, consulta esta documentación de referencia.

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Eventos

Archivos

Marketing

Programador

Webhooks

Interacciones | Reuniones

Run in Postman

Crear una reunión

Propiedades

Asociaciones

Obtener reuniones

Actualizar reuniones

Asociar reuniones existentes con registros

Eliminar una asociación

Fijar una reunión a un registro

Eliminar reuniones

Run in Postman

​Crear una reunión

​Propiedades

​Asociaciones

​Obtener reuniones

​Actualizar reuniones

​Asociar reuniones existentes con registros

​Eliminar una asociación

​Fijar una reunión a un registro

​Eliminar reuniones

Crear una reunión

Propiedades

Asociaciones

Obtener reuniones

Actualizar reuniones

Asociar reuniones existentes con registros

Eliminar una asociación

Fijar una reunión a un registro

Eliminar reuniones