> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Book a meeting

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

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/scheduler-meetings-v3.json POST /scheduler/v3/meetings/meeting-links/book
openapi: 3.0.1
info:
  title: Scheduler Meetings
  description: Meetings Service For HubSpot Sales
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-related-documentation:
    - name: Meetings guide
      url: >-
        https://developers.hubspot.com/docs/reference/api/crm/engagements/meetings
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
paths:
  /scheduler/v3/meetings/meeting-links/book:
    post:
      tags:
        - Advanced
      summary: |
        Agendar uma reunião
      description: Agende uma reunião para uma página de reunião específica.
      operationId: post-/scheduler/v3/meetings/meeting-links/book
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalMeetingBooking'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalMeetingBookingResponse'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      deprecated: true
      security:
        - oauth2:
            - crm.objects.contacts.highly_sensitive.write.v2
        - oauth2:
            - crm.objects.commercepayments.write
        - oauth2:
            - crm.objects.goals.write
        - oauth2:
            - crm.objects.line_items.write
        - oauth2:
            - crm.objects.contacts.write
        - oauth2:
            - crm.objects.products.write
        - oauth2:
            - crm.objects.projects.write
        - oauth2:
            - crm.objects.projects.sensitive.write
        - oauth2:
            - crm.objects.contacts.sensitive.write.v2
        - oauth2:
            - crm.objects.services.write
        - oauth2:
            - crm.objects.deals.sensitive.write.v2
        - oauth2:
            - tickets.highly_sensitive.v2
        - oauth2:
            - crm.objects.listings.write
        - oauth2:
            - crm.objects.appointments.sensitive.write.v2
        - oauth2:
            - crm.objects.companies.write
        - oauth2:
            - crm.objects.courses.write
        - oauth2:
            - crm.objects.appointments.write
        - oauth2:
            - tickets.sensitive.v2
        - oauth2:
            - crm.objects.deals.write
        - oauth2:
            - crm.objects.projects.highly_sensitive.write
        - oauth2:
            - crm.objects.companies.sensitive.write.v2
        - oauth2:
            - crm.objects.companies.highly_sensitive.write.v2
        - oauth2:
            - crm.objects.deals.highly_sensitive.write.v2
        - oauth2:
            - crm.schemas.meetings.write
components:
  schemas:
    ExternalMeetingBooking:
      required:
        - duration
        - email
        - firstName
        - formFields
        - lastName
        - legalConsentResponses
        - likelyAvailableUserIds
        - slug
        - startTime
      type: object
      properties:
        duration:
          type: integer
          description: A duração da reunião em milissegundos.
          format: int64
        email:
          type: string
          description: O endereço de e-mail da pessoa que está agendando a reunião.
        firstName:
          type: string
          description: O nome da pessoa que está agendando a reunião.
        formFields:
          type: array
          items:
            $ref: '#/components/schemas/ExternalBookingFormField'
        lastName:
          type: string
          description: O sobrenome da pessoa que está agendando a reunião.
        legalConsentResponses:
          type: array
          items:
            $ref: '#/components/schemas/ExternalLegalConsentResponse'
        likelyAvailableUserIds:
          type: array
          items:
            type: string
        locale:
          type: string
          description: >-
            A localidade usada para formatar datas e horas ao agendar uma
            reunião.
        slug:
          type: string
          description: O identificador de caminho exclusivo para a página da reunião.
        startTime:
          type: string
          description: >-
            A data e a hora em que a reunião está agendada para começar, no
            formato ISO 8601.
          format: date-time
        timezone:
          type: string
          description: O fuso horário em que a reunião está agendada.
    ExternalMeetingBookingResponse:
      required:
        - bookingTimezone
        - calendarEventId
        - contactId
        - duration
        - end
        - formFields
        - guestEmails
        - isOffline
        - legalConsentResponses
        - start
        - subject
      type: object
      properties:
        bookingTimezone:
          type: string
          description: O fuso horário em que a reunião foi agendada.
        calendarEventId:
          type: string
          description: O identificador exclusivo do evento de calendário da reunião.
        contactId:
          type: string
          description: O ID do contato associado à reunião.
        duration:
          type: integer
          description: A duração da reunião em milissegundos.
          format: int64
        end:
          type: string
          description: >-
            A data e a hora previstas para o término da reunião, no formato ISO
            8601.
          format: date-time
        formFields:
          type: array
          items:
            $ref: '#/components/schemas/ExternalValidatedFormField'
        guestEmails:
          type: array
          items:
            type: string
        isOffline:
          type: boolean
          description: >-
            Indica se a reunião foi agendada offline e nenhum evento de
            calendário associado foi criado.
        legalConsentResponses:
          type: array
          items:
            $ref: '#/components/schemas/ExternalLegalConsentResponse'
        locale:
          type: string
          description: >-
            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:
          type: string
          description: O local físico ou virtual onde a reunião ocorrerá.
        start:
          type: string
          description: >-
            A data e a hora em que a reunião está agendada para começar, no
            formato ISO 8601.
          format: date-time
        subject:
          type: string
          description: Título da reunião e evento de calendário.
        webConferenceMeetingId:
          type: string
          description: O identificador exclusivo para a reunião por videoconferência.
        webConferenceUrl:
          type: string
          description: O URL para acessar a videoconferência da reunião.
    ExternalBookingFormField:
      required:
        - name
        - value
      type: object
      properties:
        name:
          type: string
          description: O nome do campo do formulário.
        value:
          type: string
          description: O valor associado ao campo do formulário.
    ExternalLegalConsentResponse:
      required:
        - communicationTypeId
        - consented
      type: object
      properties:
        communicationTypeId:
          type: string
          description: >-
            O ID do formulário de consentimento de comunicação que está sendo
            registrado.
        consented:
          type: boolean
          description: >-
            Se o usuário deu consentimento para o tipo de comunicação
            especificado.
    ExternalValidatedFormField:
      required:
        - isCustom
        - label
        - name
        - value
      type: object
      properties:
        fieldType:
          type: string
          description: >-
            O tipo específico de entrada do campo de formulário. Corresponde aos
            tipos de propriedade (por exemplo, "select", "radio", "date" etc.).
        isCustom:
          type: boolean
          description: Indica se o campo do formulário é um campo personalizado.
        label:
          type: string
          description: O rótulo de texto associado ao campo do formulário.
        name:
          type: string
          description: >-
            O identificador de nome do campo de formulário inclui sublinhados no
            lugar de espaços (por exemplo, o rótulo "meu formulário" é
            convertido para "meu_formulário").
        translatedLabel:
          type: string
          description: O rótulo de texto traduzido para o campo do formulário.
        value:
          type: string
          description: O valor associado ao campo do formulário.
        valueLabel:
          type: string
          description: >-
            O rótulo de texto associado à seleção ou opção de um campo de
            formulário.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            crm.objects.appointments.sensitive.write.v2: ''
            crm.objects.appointments.write: ''
            crm.objects.commercepayments.write: ''
            crm.objects.companies.highly_sensitive.write.v2: ''
            crm.objects.companies.sensitive.write.v2: ''
            crm.objects.companies.write: ''
            crm.objects.contacts.highly_sensitive.write.v2: ''
            crm.objects.contacts.sensitive.write.v2: ''
            crm.objects.contacts.write: ''
            crm.objects.courses.write: ''
            crm.objects.deals.highly_sensitive.write.v2: ''
            crm.objects.deals.sensitive.write.v2: ''
            crm.objects.deals.write: ''
            crm.objects.goals.write: ''
            crm.objects.line_items.write: ''
            crm.objects.listings.write: ''
            crm.objects.products.write: ''
            crm.objects.projects.highly_sensitive.write: ''
            crm.objects.projects.sensitive.write: ''
            crm.objects.projects.write: ''
            crm.objects.services.write: ''
            crm.schemas.meetings.write: ''
            scheduler.meetings.meeting-link.read: ''
            tickets.highly_sensitive.v2: ''
            tickets.sensitive.v2: ''

````