Book a meeting

Agende uma reunião para uma página de reunião específica.

POST /scheduler/2026-03/meetings/meeting-links/book

Agendar uma reunião

cURL

curl --request POST \
  --url https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "duration": 123,
  "email": "<string>",
  "firstName": "<string>",
  "formFields": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "lastName": "<string>",
  "legalConsentResponses": [
    {
      "communicationTypeId": "<string>",
      "consented": true
    }
  ],
  "likelyAvailableUserIds": [
    "<string>"
  ],
  "slug": "<string>",
  "startTime": "2023-11-07T05:31:56Z",
  "locale": "<string>",
  "timezone": "<string>"
}
'

200

{
  "bookingTimezone": "<string>",
  "calendarEventId": "<string>",
  "contactId": "<string>",
  "duration": 123,
  "end": "2023-11-07T05:31:56Z",
  "formFields": [
    {
      "isCustom": true,
      "label": "<string>",
      "name": "<string>",
      "value": "<string>",
      "fieldType": "<string>",
      "translatedLabel": "<string>",
      "valueLabel": "<string>"
    }
  ],
  "guestEmails": [
    "<string>"
  ],
  "isOffline": true,
  "legalConsentResponses": [
    {
      "communicationTypeId": "<string>",
      "consented": true
    }
  ],
  "start": "2023-11-07T05:31:56Z",
  "subject": "<string>",
  "locale": "<string>",
  "location": "<string>",
  "webConferenceMeetingId": "<string>",
  "webConferenceUrl": "<string>"
}

Supported products

Required Scopes

Autorizações

Authorization · string · header · obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Corpo

application/json

duration · integer<int64> · obrigatório

A duração da reunião em milissegundos.

email · string · obrigatório

O endereço de e-mail da pessoa que está agendando a reunião.

firstName · string · obrigatório

O nome da pessoa que está agendando a reunião.

formFields · object[] · obrigatório

Show child attributes

lastName · string · obrigatório

O sobrenome da pessoa que está agendando a reunião.

legalConsentResponses · object[] · obrigatório

Show child attributes

likelyAvailableUserIds · string[] · obrigatório

slug · string · obrigatório

O identificador de caminho exclusivo para a página da reunião.

startTime · string<date-time> · obrigatório

A data e a hora em que a reunião está agendada para começar, no formato ISO 8601.

locale · string

A localidade usada para formatar datas e horas ao agendar uma reunião.

timezone · string

O fuso horário em que a reunião está agendada.

Resposta

200

application/json

successful operation

bookingTimezone · string · obrigatório

O fuso horário em que a reunião foi agendada.

calendarEventId · string · obrigatório

O identificador exclusivo do evento de calendário da reunião.

contactId · string · obrigatório

O ID do contato associado à reunião.

duration · integer<int64> · obrigatório

A duração da reunião em milissegundos.

end · string<date-time> · obrigatório

A data e a hora previstas para o término da reunião, no formato ISO 8601.

formFields · object[] · obrigatório

Show child attributes

guestEmails · string[] · obrigatório

isOffline · boolean · obrigatório

Indica se a reunião foi agendada offline e nenhum evento de calendário associado foi criado.

legalConsentResponses · object[] · obrigatório

Show child attributes

start · string<date-time> · obrigatório

A data e a hora em que a reunião está agendada para começar, no formato ISO 8601.

subject · string · obrigatório

Título da reunião e evento de calendário.

locale · string

A localidade na qual a reunião foi agendada é usada para determinar a formatação da data na descrição do evento de calendário.

location · string

O local físico ou virtual onde a reunião ocorrerá.

webConferenceMeetingId · string

O identificador exclusivo para a reunião por videoconferência.

webConferenceUrl · string

O URL para acessar a videoconferência da reunião.