Engajamentos | Reuniões

Run in Postman

Requisitos de escopo

Use a API de engajamento de reuniões para registrar e gerenciar reuniões nos registros do CRM. Você pode registrar atividades de reunião no HubSpot ou por meio da API de reuniões. Você pode recuperar, atualizar ou excluir engajamentos de reunião que são incluídos manualmente em um registro, agendados usando a ferramenta de reuniões ou agendados usando a integração de calendário do Google Agenda ou do Office 365. Abaixo, aprenda os métodos básicos de gerenciamento de reuniões por meio da API. Para exibir todos os endpoints disponíveis e seus requisitos, verifique a documentação de referência.

Criar uma reunião

Para criar um engajamento de reunião, faça uma solicitação POST para /crm/v3/objects/meetings. No corpo da solicitação, adicione detalhes da reunião em um objeto de propriedades. Você também pode adicionar um objeto de associações para associar sua nova reunião a um registro existente (por exemplo, contatos, empresas).

Propriedades

No objeto de propriedades, você pode incluir os seguintes campos:

Campo	Descrição
`hs_timestamp`	Obrigatório. Este campo marca a data e a hora em que a reunião ocorreu. Você pode usar um carimbo de data e hora do Unix em milissegundos ou no formato UTC. Quando o valor da propriedade estiver faltando, o valor padrão será `hs_meeting_start_time.`
`hs_meeting_title`	O título da reunião.
`hubspot_owner_id`	O ID do proprietário associado à reunião. Este campo determina o usuário listado como o criador da reunião na linha do tempo do registro.
`hs_meeting_body`	A descrição da reunião.
`hs_internal_meeting_notes`	As observações internas que você faz para sua equipe durante uma reunião que não estão incluídas na descrição da reunião do participante.
`hs_meeting_external_url`	O URL externo do evento de calendário. Por exemplo, pode ser um link de calendário do Google ou do Microsoft Outlook.
`hs_meeting_location`	Onde a reunião acontecerá. O valor pode ser um endereço físico, uma sala de conferências, um link de videoconferência ou um número de telefone. Isso aparece no convite no calendário do participante.
`hs_meeting_start_time`	A data e hora de início da reunião. O valor dessa propriedade deve corresponder ao valor de `hs_timestamp`.
`hs_meeting_end_time`	A data e hora de término da reunião.
`hs_meeting_outcome`	O resultado da reunião. Os valores de resultado são programado, concluído, reprogramado, não compareceu e cancelado.
`hs_activity_type`	O tipo de reunião. As opções se baseiam nos tipos de reunião definidos na sua conta da HubSpot.
`hs_attachment_ids`	Os IDs dos anexos da reunião. Vários IDs de anexo são separados por ponto e vírgula.

Associações

Para criar e associar uma reunião a registros existentes, inclua um objeto de associações na solicitação. Por exemplo, para criar e associar uma reunião a contatos, a solicitação pode ser semelhante à seguinte:

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

O objeto de associações deve incluir:

Campo	Descrição
`to`	O registro que deseja associar à reunião, especificado por seu valor de `id` exclusivo.
`types`	O tipo de associação entre a reunião e o registro. Inclua `associationCategory` e `associationTypeId`. Os IDs de tipo de associação padrão são listados aqui, ou você pode recuperar o valor de tipos de associação personalizados (ou seja, rótulos) por meio da API de associações.

Saiba mais sobre a criação de reuniões em lote na [documentação de referência.

Recuperar reuniões

Você pode recuperar reuniões individualmente ou em massa. Saiba mais sobre a recuperação em lote na documentação de referência. Para recuperar uma reunião individual pelo seu ID, faça uma solicitaçãoGET para /crm/v3/objects/meetings/{meetingId}. Você também pode incluir os seguintes parâmetros no URL da solicitação:

Parâmetro	Descrição
`properties`	Uma lista separada por vírgulas das propriedades a serem retornadas.
`associations`	Uma lista separada por vírgulas dos objetos dos quais você deseja recuperar os IDs de registro associados.

Para solicitar uma lista de todas as reuniões, faça uma solicitação GET para crm/v3/objects/meetings. Você pode incluir os seguintes parâmetros na URL da solicitação:

Parâmetro	Descrição
`limit`	O número máximo de resultados a serem exibidos por página.
`properties`	Uma lista separada por vírgulas das propriedades a serem retornadas.

Atualizar reuniões

Você pode atualizar reuniões individualmente ou em massa. Para atualizar uma reunião individual pelo seu ID, faça uma solicitaçãoPATCH para /crm/v3/objects/meetings/{meetingId}. No corpo da solicitação, inclua as propriedades de reunião que deseja atualizar. Por exemplo, o corpo da sua solicitação pode ser parecido com o seguinte:

//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"
  }
}'

O HubSpot ignorará valores para propriedades somente leitura e inexistentes. Para limpar um valor de propriedade, passe uma string vazia para a propriedade no corpo da solicitação. Saiba mais sobre a atualização em lotes na documentação de referência.

Associar reuniões existentes a registros

Para associar uma reunião a registros, como um contato e suas empresas associadas, faça uma solicitação PUT para /crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}. A URL da solicitação contém os campos a seguir:

Campo	Descrição
`meetingId`	O ID do proprietário da reunião.
`toObjectType`	O tipo de objeto ao qual você deseja associar a reunião (por exemplo, contato ou empresa).
`toObjectId`	O ID do registro ao qual você deseja associar a reunião.
`associationTypeId`	O ID do tipo de associação entre a reunião e o outro tipo de objeto. Você pode recuperar esse valor por meio da API de associações.

Por exemplo, a URL da sua solicitação pode ser parecida com o seguinte: https://api.hubspot.com/crm/v3/objects/meetings/17612479134/associations/contact/104901/200

Remover uma associação

Para remover uma associação entre uma chamada e um registro, faça uma solicitação DELETE para o mesmo URL acima: /crm/v3/objects/meetings/{meetingId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}

Fixar uma reunião em um registro

Você pode fixar uma reunião em um registro para que permaneça no topo da linha do tempo do registro. A chamada já deve estar associada ao registro antes da fixação e você só pode fixar uma atividade por registo. Para fixar uma reunião, inclua o id da reunião no campo hs_pinned_engagement_id ao criar ou atualizar um registro por meio das APIs de objeto. Saiba mais sobre como usar as APIs de empresas,contatos, negócios, tickets e objetos personalizados.

Excluir reuniões

Você pode excluir reuniões individualmente ou em massa, o que adicionará a reunião à lixeira no HubSpot. Você pode [restaurar posteriormente a reunião da linha do tempo do registro. Para excluir uma reunião individual pelo seu ID, faça uma solicitaçãoDELETE para /crm/v3/objects/meetings/{meetingId}. Saiba mais sobre exclusão em lote na documentação de referência.

Conta e configurações

Gerenciamento de aplicativo

Autenticação

Automação

CMS

Preferências de comunicação

Conversas

CRM

Data Studio

Eventos

Arquivos

Marketing

Reuniões

Receita

Webhooks

Diário de Webhooks

Engajamentos | Reuniões

Run in Postman

Criar uma reunião

Propriedades

Associações

Recuperar reuniões

Atualizar reuniões

Associar reuniões existentes a registros

Remover uma associação

Fixar uma reunião em um registro

Excluir reuniões

Run in Postman

​Criar uma reunião

​Propriedades

​Associações

​Recuperar reuniões

​Atualizar reuniões

​Associar reuniões existentes a registros

​Remover uma associação

​Fixar uma reunião em um registro

​Excluir reuniões

Criar uma reunião

Propriedades

Associações

Recuperar reuniões

Atualizar reuniões

Associar reuniões existentes a registros

Remover uma associação

Fixar uma reunião em um registro

Excluir reuniões