> ## 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.

# Create a new calendar event for a meeting

> Crie um novo evento de calendário e um novo objeto de reunião, fornecendo os detalhes necessários, como associações, lembretes por e-mail, propriedades do objeto de reunião e fuso horário.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/scheduler-meetings-v3.json POST /scheduler/v3/meetings/calendar
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/calendar:
    post:
      tags:
        - Advanced
      summary: Crie um novo evento de reunião de calendário.
      description: >-
        Crie um novo evento de calendário e um novo objeto de reunião,
        fornecendo os detalhes necessários, como associações, lembretes por
        e-mail, propriedades do objeto de reunião e fuso horário.
      operationId: post-/scheduler/v3/meetings/calendar
      parameters:
        - name: organizerUserId
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalCalendarMeetingEventCreateRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCalenderMeetingEventResponse'
        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:
    ExternalCalendarMeetingEventCreateRequest:
      required:
        - associations
        - emailReminderSchedule
        - properties
        - timezone
      type: object
      properties:
        associations:
          type: array
          items:
            $ref: '#/components/schemas/ExternalAssociationCreateRequest'
        emailReminderSchedule:
          $ref: '#/components/schemas/ExternalEmailReminderSchedule'
        properties:
          $ref: '#/components/schemas/ExternalCalendarMeetingEventCreateProperties'
        timezone:
          type: string
          description: >-
            A propriedade de fuso horário que será definida no evento de
            reunião.
    ExternalCalenderMeetingEventResponse:
      required:
        - createdAt
        - id
        - lastUpdatedAt
        - properties
      type: object
      properties:
        createdAt:
          type: string
          description: >-
            A data e a hora em que o evento de reunião foi criado inicialmente,
            no formato ISO 8601.
          format: date-time
        id:
          type: string
          description: O identificador exclusivo do evento de reunião.
        lastUpdatedAt:
          type: string
          description: >-
            A data e a hora da última atualização do evento de reunião, no
            formato ISO 8601.
          format: date-time
        properties:
          $ref: '#/components/schemas/ExternalCalendarMeetingEventResponseProperties'
    ExternalAssociationCreateRequest:
      required:
        - to
        - types
      type: object
      properties:
        to:
          $ref: '#/components/schemas/PublicObjectId'
        types:
          type: array
          items:
            $ref: '#/components/schemas/AssociationSpec'
    ExternalEmailReminderSchedule:
      required:
        - reminders
        - shouldIncludeInviteDescription
      type: object
      properties:
        reminders:
          type: array
          items:
            $ref: '#/components/schemas/ExternalReminder'
        shouldIncludeInviteDescription:
          type: boolean
          description: Se a descrição do convite deve ser incluída no lembrete.
    ExternalCalendarMeetingEventCreateProperties:
      required:
        - hs_meeting_end_time
        - hs_meeting_outcome
        - hs_meeting_start_time
        - hs_meeting_title
        - hs_timestamp
        - hubspot_owner_id
      type: object
      properties:
        hs_activity_type:
          type: string
          description: >-
            O tipo de atividade da reunião. Os valores aceitáveis ​​baseiam-se
            nos tipos de chamada e reunião definidos no portal.
        hs_attachment_ids:
          type: array
          items:
            type: string
        hs_attendee_owner_ids:
          type: array
          items:
            type: string
        hs_internal_meeting_notes:
          type: string
          description: Observações internas relativas à reunião.
        hs_meeting_body:
          type: string
          description: A descrição da reunião e do evento de calendário.
        hs_meeting_end_time:
          type: string
          description: A hora de término da reunião, no formato ISO 8601.
          format: date-time
        hs_meeting_location:
          type: string
          description: >-
            O endereço físico, a localização virtual ou o número de telefone
            onde a reunião ocorrerá.
        hs_meeting_location_type:
          type: string
          description: >-
            O tipo de local da reunião. Os valores aceitáveis ​​são: ADDRESS,
            CUSTOM, PHONE.
          enum:
            - ADDRESS
            - CUSTOM
            - PHONE
        hs_meeting_outcome:
          type: string
          description: >-
            O resultado da reunião. Os valores padrão aceitáveis ​​são:
            SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, CANCELED. Esta
            propriedade pode ser alterada para incluir valores personalizados
            adicionais.
        hs_meeting_start_time:
          type: string
          description: A hora de início da reunião, no formato ISO 8601.
          format: date-time
        hs_meeting_title:
          type: string
          description: Título da reunião e evento de calendário.
        hs_timestamp:
          type: string
          description: >-
            A hora de início da reunião no formato ISO 8601. Este valor deve ser
            o mesmo que "hs_meeting_start_time".
          format: date-time
        hubspot_owner_id:
          type: string
          description: O ownerId do usuário do HubSpot que será o anfitrião da reunião.
    ExternalCalendarMeetingEventResponseProperties:
      required:
        - hs_engagement_source
        - hs_engagement_source_id
        - hs_meeting_end_time
        - hs_meeting_outcome
        - hs_meeting_start_time
        - hs_meeting_title
        - hs_timestamp
      type: object
      properties:
        hs_activity_type:
          type: string
          description: >-
            O tipo de atividade da reunião. Os valores aceitáveis ​​baseiam-se
            nos tipos de chamada e reunião definidos no portal.
        hs_attachment_ids:
          type: array
          items:
            type: string
        hs_attendee_owner_ids:
          type: array
          items:
            type: string
        hs_engagement_source:
          type: string
          description: A fonte do engajamento será sempre "MEETINGS".
          enum:
            - ACADEMY
            - ACCEPTANCE_TEST
            - ACTIVITY_AUTO_ASSOCIATE
            - ACTIVITY_LOG_REVERT
            - ADS
            - AI_GROUP
            - ANALYTICS
            - API
            - APPROVALS
            - ASSISTS
            - ASSOCIATIONS
            - AUTO_ASSOCIATE_BY_DOMAIN
            - AUTOMATION_JOURNEY
            - AUTOMATION_PLATFORM
            - AVATARS_SERVICE
            - BATCH_UPDATE
            - BCC_TO_CRM
            - BEHAVIORAL_EVENTS
            - BET_ASSIGNMENT
            - BET_CRM_CONNECTOR
            - BIDEN
            - BILLING
            - BOT
            - BREEZE_AGENT
            - CALCULATED
            - CENTRAL_EXCHANGE_RATES
            - CHATSPOT
            - CLONE_OBJECTS
            - COMMUNICATOR
            - COMPANIES
            - COMPANY_FAMILIES
            - COMPANY_INSIGHTS
            - CONNECTED_ACCOUNT
            - CONTACTS
            - CONTACTS_WEB
            - CONTENT_MEMBERSHIP
            - CONVERSATIONAL_ENRICHMENT
            - CONVERSATIONS
            - CRM_PROCESSES_PLATFORM
            - CRM_UI
            - CRM_UI_BULK_ACTION
            - CUSTOMER_AGENT
            - CUSTOMER_PORTAL
            - DATA_ENRICHMENT
            - DATA_QUALITY
            - DATASET
            - DEALS
            - DEFAULT
            - DELETE_OBJECTS
            - DI_WRITE_TO_CRM
            - EMAIL
            - EMAIL_INBOX_IMPORT
            - EMAIL_INTEGRATION
            - ENGAGEMENTS
            - EXTENSION
            - FILE_MANAGER
            - FLYWHEEL_PRODUCT_DATA_SYNC
            - FORECASTING
            - FORM
            - FORWARD_TO_CRM
            - GMAIL_INTEGRATION
            - GOALS
            - HEISENBERG
            - HELP_DESK
            - HELP_DESK_AI
            - IMPORT
            - INTEGRATION
            - INTEGRATIONS_PLATFORM
            - INTEGRATIONS_SYNC
            - INTENT
            - INTERNAL_PROCESSING
            - LEADIN
            - LEGAL_BASIS_REMEDIATION
            - MARKET_SOURCING
            - MARKETPLACE
            - MARKETS
            - MEETINGS
            - MERGE_COMPANIES
            - MERGE_CONTACTS
            - MERGE_OBJECTS
            - MERGE_REVERT_OBJECTS
            - MICROAPPS
            - MIGRATION
            - MOBILE_ANDROID
            - MOBILE_IOS
            - PAYMENTS
            - PIPELINE_SETTINGS
            - PLAYBOOKS
            - PORTAL_OBJECT_SYNC
            - PORTAL_USER_ASSOCIATOR
            - PRESENTATIONS
            - PRIMARY_AUTOMATION
            - PROPERTY_DEFAULT_VALUE
            - PROPERTY_RESTORE
            - PROPERTY_SETTINGS
            - PROSPECTING_AGENT
            - QUOTAS
            - QUOTES
            - RECYCLING_BIN
            - RESTORE_OBJECTS
            - REVENUE_PLATFORM
            - SALES
            - SALES_MESSAGES
            - SALESFORCE
            - SEQUENCES
            - SETTINGS
            - SIDEKICK
            - SIGNALS
            - SLACK_INTEGRATION
            - SMART_DATA_CAPTURE
            - SOCIAL
            - SUCCESS
            - TALLY
            - TASK
            - UNKNOWN
            - WAL_INCREMENTAL
            - WORK_UI
            - WORKFLOW_CONTACT_DELETE_ACTION
            - WORKFLOWS
        hs_engagement_source_id:
          type: string
          description: >-
            O ID associado ao processo que criou o engajamento. Deve estar
            sempre vazio ao criar eventos de reunião por meio desta API.
        hs_include_description_in_reminder:
          type: string
          description: Indica se a descrição da reunião deve ser incluída no lembrete.
        hs_internal_meeting_notes:
          type: string
          description: Observações internas relativas à reunião.
        hs_meeting_body:
          type: string
          description: A descrição da reunião e do evento de calendário.
        hs_meeting_end_time:
          type: string
          description: A hora de término da reunião no formato ISO 8601.
          format: date-time
        hs_meeting_external_url:
          type: string
          description: O URL do evento de calendário referente à reunião.
        hs_meeting_location:
          type: string
          description: >-
            O endereço físico, a localização virtual ou o número de telefone
            onde a reunião ocorrerá.
        hs_meeting_location_type:
          type: string
          description: >-
            O tipo de local da reunião. Os valores aceitáveis ​​são: ADDRESS,
            CUSTOM, PHONE.
          enum:
            - ADDRESS
            - CUSTOM
            - PHONE
        hs_meeting_outcome:
          type: string
          description: >-
            O resultado da reunião. Os valores padrão aceitáveis ​​são:
            SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, CANCELED. Esta
            propriedade pode ser alterada para incluir valores personalizados
            adicionais.
        hs_meeting_start_time:
          type: string
          description: A hora de início da reunião no formato ISO 8601.
          format: date-time
        hs_meeting_title:
          type: string
          description: Título da reunião e evento de calendário.
        hs_timestamp:
          type: string
          description: >-
            A hora de início da reunião no formato ISO 8601. Este valor deve ser
            o mesmo que "hs_meeting_start_time".
          format: date-time
        hs_unique_id:
          type: string
          description: O ID exclusivo do evento de calendário criado.
        hubspot_owner_id:
          type: string
          description: >-
            O ID do proprietário do usuário do HubSpot que será o anfitrião da
            reunião.
    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
    PublicObjectId:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: O identificador exclusivo de um objeto.
      description: Contém o ID de um Objeto Público
    AssociationSpec:
      required:
        - associationCategory
        - associationTypeId
      type: object
      properties:
        associationCategory:
          type: string
          description: A categoria da associação, por exemplo, "HUBSPOT_DEFINED".
          enum:
            - HUBSPOT_DEFINED
            - INTEGRATOR_DEFINED
            - USER_DEFINED
            - WORK
        associationTypeId:
          type: integer
          description: O ID que representa o tipo específico de associação.
          format: int32
      description: >-
        Define o tipo, a direção e os detalhes do relacionamento entre dois
        objetos do CRM.
    ExternalReminder:
      required:
        - numberOfTimeUnits
        - timeUnit
      type: object
      properties:
        numberOfTimeUnits:
          type: integer
          description: >-
            O número de timeUnits antes do início da reunião em que o lembrete
            será enviado.
          format: int32
        timeUnit:
          type: string
          description: 'Os valores aceitos são: WEEKS, DAYS, HOURS, MINUTES.'
          enum:
            - DAYS
            - HOURS
            - MINUTES
            - WEEKS
    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: ''

````