HubSpot: Book Meeting

← Scheduler operations · Get started

Operation hubspot.scheduler_create_meeting

Provider route: POST /scheduler/2026-09/meetings/meeting-links/book. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["scheduler"]["createMeeting"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.scheduler.createMeeting(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.scheduler.create_meeting(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Book Meeting — request body — body

Referenced models: Book Meeting — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Book Meeting — response body

Referenced models: Book Meeting — response body

Schemas

Book Meeting — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
duration	integer	Required within parent	An integer representing the duration of the meeting in minutes. Format: int64
email	string	Required within parent	The email address of the person booking the meeting.
firstName	string	Required within parent	The first name of the person booking the meeting.
formFields	array	Required within parent	An array of form fields filled out by the participant, each containing a name and value.
formFields[]	Model	Each item	Expand Book Meeting — request body — body form Fields item
lastName	string	Required within parent	The last name of the person booking the meeting.
legalConsentResponses	array	Required within parent	An array of legal consent responses, each detailing the consent given by the participant.
legalConsentResponses[]	Model	Each item	Expand Book Meeting — response body — legal Consent Responses item
likelyAvailableUserIds	array	Required within parent	An array of strings representing the user IDs of those likely available for the meeting.
likelyAvailableUserIds[]	string	Each item
locale	string	Optional	A string representing the locale of the person booking the meeting.
slug	string	Required within parent	A string representing the unique identifier for the meeting link.
startTime	string	Required within parent	The start time of the meeting in ISO 8601 date-time format. Format: date-time
timezone	string	Optional	A string representing the timezone of the person booking the meeting.

Referenced models: Book Meeting — request body — body form Fields item, Book Meeting — response body — legal Consent Responses item

Book Meeting — response body

Field	Type	Presence	Description and constraints
$	object	Root
bookingTimezone	string	Required within parent	The timezone in which the meeting was booked, represented as a string.
calendarEventId	string	Required within parent	The unique identifier for the calendar event associated with this meeting.
contactId	string	Required within parent	The unique identifier for the contact associated with this meeting.
duration	JSON	Required within parent
duration (anyOf 1)	integer	Alternative	The duration of the meeting in minutes, represented as an integer. Format: int64
duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end	string	Required within parent	The end date and time of the meeting, in ISO 8601 format. Format: date-time
formFields	array	Required within parent	An array of validated form fields submitted during the booking process, each represented by an ExternalValidatedFormField object.
formFields[]	Model	Each item	Expand Book Meeting — response body — form Fields item
guestEmails	array	Required within parent	An array of email addresses for the guests invited to the meeting.
guestEmails[]	string	Each item
isOffline	boolean	Required within parent	A boolean indicating whether the meeting is offline (true) or online (false).
legalConsentResponses	array	Required within parent	An array of legal consent responses associated with the meeting, each represented by an ExternalLegalConsentResponse object.
legalConsentResponses[]	Model	Each item	Expand Book Meeting — response body — legal Consent Responses item
locale	string	Optional	The locale setting for the meeting, represented as a string.
location	string	Optional	The location of the meeting, represented as a string.
start	string	Required within parent	The start date and time of the meeting, in ISO 8601 format. Format: date-time
subject	string	Required within parent	The subject or title of the meeting, represented as a string.
webConferenceMeetingId	string	Optional	The unique identifier for the web conference meeting, if applicable.
webConferenceUrl	string	Optional	The URL for the web conference associated with the meeting, if applicable.

Referenced models: Book Meeting — response body — legal Consent Responses item, Book Meeting — response body — form Fields item

Book Meeting — request body — body form Fields item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	The name of the form field, represented as a string.
value	string	Required within parent	The value associated with the form field, represented as a string.

Book Meeting — response body — legal Consent Responses item

Field	Type	Presence	Description and constraints
$	object	Root
communicationTypeId	string	Required within parent	A string representing the unique identifier for the type of communication for which consent is being recorded.
consented	boolean	Required within parent	A boolean indicating whether the user has given consent for the communication type. It is true if consent is given, otherwise false.

Book Meeting — response body — form Fields item

Field	Type	Presence	Description and constraints
$	object	Root
fieldType	string	Optional	The type of the form field, represented as a string.
isCustom	boolean	Required within parent	A boolean indicating whether the form field is custom-defined.
label	string	Required within parent	The display label for the form field, represented as a string.
name	string	Required within parent	The name of the form field, represented as a string.
translatedLabel	string	Optional	The translated label for the form field, represented as a string.
value	string	Required within parent	The value assigned to the form field, represented as a string.
valueLabel	string	Optional	A label for the field's value, represented as a string.

Policy, approvals and errors

SDK function policy ID: hubspot.scheduler_create_meeting. Catalog operation: scheduler_create_meeting. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider 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", "tickets.highly_sensitive.v2", "tickets.sensitive.v2"]

Official provider source