HUhubspot
Advanced

Book a meeting

Changed on

Book a meeting for a specified meeting page.

post/scheduler/v3/meetings/meeting-links/book

Request

  • Base URL
    https://api.hubapi.com
  • Auth
    • OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.contacts.highly_sensitive.write.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.tickets.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.commercepayments.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.goals.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.line_items.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.contacts.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.products.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.projects.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.contacts.sensitive.write.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.projects.sensitive.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.services.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.deals.sensitive.write.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopestickets.highly_sensitive.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.listings.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.appointments.sensitive.write.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.companies.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.courses.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.appointments.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopestickets.sensitive.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.deals.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.projects.highly_sensitive.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.companies.sensitive.write.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.companies.highly_sensitive.write.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.deals.highly_sensitive.write.v2
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.objects.meetings.write
    • or OAuth 2
      Authorization codehttps://app.hubspot.com/oauth/authorize
      Token URLhttps://api.hubapi.com/oauth/v1/token
      Scopescrm.schemas.meetings.write

Request body

durationinteger required

The duration of the meeting in milliseconds.

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
localestring

The locale used for formatting dates and times in the meeting booking.

slugstring required

The unique path identifier for the meeting page.

startTimestring date-time required

The date and time when the meeting is scheduled to start, in ISO 8601 format.

timezonestring

The timezone in which the meeting is scheduled.

Response

successful operation

bookingTimezonestring required

The timezone the meeting was booked from.

calendarEventIdstring required

The unique identifier for the meeting's calendar event.

contactIdstring required

The ID of the contact associated to the meeting.

durationinteger required

The duration of the meeting in milliseconds.

endstring date-time required

The date and time when the meeting is scheduled to end, in ISO 8601 format.

guestEmailsstring[] required
isOfflineboolean required

Whether the meeting was booked offline and no associated calendar event was created.

localestring

The locale the meeting was booked with, used to determine date formatting in calendar event description.

locationstring

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

startstring date-time required

The date and time when the meeting is scheduled to start, in ISO 8601 format.

subjectstring required

The title of the meeting and calendar event.

webConferenceMeetingIdstring

The unique identifier for the web conference meeting.

webConferenceUrlstring

The URL for accessing the meeting's web conference.

Changes

  • v393e16a7a6b04Revision 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

  • v3a50a2ed36bd6Revision 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