HUhubspot
Advanced

Book Meeting

Changed on

Book a meeting using a meeting link in your HubSpot account. This endpoint allows you to specify details such as the meeting duration, start time, and participant information. It is useful for scheduling meetings with external participants through a predefined meeting link.

post/scheduler/2027-03-beta/meetings/meeting-links/book

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/scheduler/2027-03-beta/meetings/meeting-links/book
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.highly_sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.commercepayments.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.goals.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.line_items.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.products.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.sensitive.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.contacts.sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.services.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: tickets.highly_sensitive.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.listings.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.appointments.sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.courses.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.appointments.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: tickets.sensitive.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.projects.highly_sensitive.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.companies.highly_sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.deals.highly_sensitive.write.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.schemas.meetings.write

Request body

durationinteger required

The duration of the meeting in minutes, represented as a 64-bit integer.

emailstring required

The email address of the person booking the meeting.

firstNamestring required

The first name of the person booking the meeting.

lastNamestring required

The last name of the person booking the meeting.

likelyAvailableUserIdsstring[] required

An array of user IDs, represented as strings, indicating the users who are likely available for the meeting.

localestring

The locale setting for the meeting, represented as a string.

slugstring required

A string identifier for the meeting link, used to uniquely identify the meeting booking.

startTimestring date-time required

The start time of the meeting, represented in ISO 8601 date-time format.

timezonestring

The time zone in which the meeting will occur, represented as a string.

Response

successful operation

bookingTimezonestring required

The timezone in which the meeting was booked.

calendarEventIdstring required

The unique identifier for the calendar event associated with the booked meeting.

contactIdstring required

The unique identifier for the contact associated with the meeting.

durationinteger required

The duration of the meeting in minutes, represented as a 64-bit integer.

endstring date-time required

The end date and time of the meeting, in ISO 8601 format.

guestEmailsstring[] required

An array of email addresses for guests invited to the meeting.

isOfflineboolean required

A boolean indicating whether the meeting is offline (true) or online (false).

localestring

The locale setting for the meeting, which may affect formatting and language.

locationstring

The physical or virtual location where the meeting will take place.

startstring date-time required

The start date and time of the meeting, in ISO 8601 format.

subjectstring required

The subject or title of the meeting.

webConferenceMeetingIdstring

The unique identifier for the web conference meeting, if applicable.

webConferenceUrlstring

The URL for joining the web conference meeting, if applicable.

Changes

  • 2027-03-beta6d3443ad681bRevision changes
    • info

      the security scope crm.objects.contacts.highly_sensitive.write.v2 was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.schemas.meetings.write was removed from the endpoint's security scheme oauth2

  • 2027-03-betaa9440c8f9a36Revision changes
    • info

      the security scope crm.objects.contacts.highly_sensitive.write.v2 was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.schemas.meetings.write was removed from the endpoint's security scheme oauth2