curl --request POST \
--url https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"duration": 123,
"email": "<string>",
"firstName": "<string>",
"formFields": [
{
"name": "<string>",
"value": "<string>"
}
],
"lastName": "<string>",
"legalConsentResponses": [
{
"communicationTypeId": "<string>",
"consented": true
}
],
"likelyAvailableUserIds": [
"<string>"
],
"slug": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"locale": "<string>",
"timezone": "<string>"
}
'{
"bookingTimezone": "<string>",
"calendarEventId": "<string>",
"contactId": "<string>",
"duration": 123,
"end": "2023-11-07T05:31:56Z",
"formFields": [
{
"isCustom": true,
"label": "<string>",
"name": "<string>",
"value": "<string>",
"fieldType": "<string>",
"translatedLabel": "<string>",
"valueLabel": "<string>"
}
],
"guestEmails": [
"<string>"
],
"isOffline": true,
"legalConsentResponses": [
{
"communicationTypeId": "<string>",
"consented": true
}
],
"start": "2023-11-07T05:31:56Z",
"subject": "<string>",
"locale": "<string>",
"location": "<string>",
"webConferenceMeetingId": "<string>",
"webConferenceUrl": "<string>"
}Book a meeting
Book a meeting for a specified meeting page.
curl --request POST \
--url https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"duration": 123,
"email": "<string>",
"firstName": "<string>",
"formFields": [
{
"name": "<string>",
"value": "<string>"
}
],
"lastName": "<string>",
"legalConsentResponses": [
{
"communicationTypeId": "<string>",
"consented": true
}
],
"likelyAvailableUserIds": [
"<string>"
],
"slug": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"locale": "<string>",
"timezone": "<string>"
}
'{
"bookingTimezone": "<string>",
"calendarEventId": "<string>",
"contactId": "<string>",
"duration": 123,
"end": "2023-11-07T05:31:56Z",
"formFields": [
{
"isCustom": true,
"label": "<string>",
"name": "<string>",
"value": "<string>",
"fieldType": "<string>",
"translatedLabel": "<string>",
"valueLabel": "<string>"
}
],
"guestEmails": [
"<string>"
],
"isOffline": true,
"legalConsentResponses": [
{
"communicationTypeId": "<string>",
"consented": true
}
],
"start": "2023-11-07T05:31:56Z",
"subject": "<string>",
"locale": "<string>",
"location": "<string>",
"webConferenceMeetingId": "<string>",
"webConferenceUrl": "<string>"
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
The duration of the meeting in milliseconds.
The email address of the person booking the meeting.
The first name of the person booking the meeting.
Show child attributes
Show child attributes
The last name of the person booking the meeting.
Show child attributes
Show child attributes
The unique path identifier for the meeting page.
The date and time when the meeting is scheduled to start, in ISO 8601 format.
The locale used for formatting dates and times in the meeting booking.
The timezone in which the meeting is scheduled.
Response
successful operation
The timezone the meeting was booked from.
The unique identifier for the meeting's calendar event.
The ID of the contact associated to the meeting.
The duration of the meeting in milliseconds.
The date and time when the meeting is scheduled to end, in ISO 8601 format.
Show child attributes
Show child attributes
Whether the meeting was booked offline and no associated calendar event was created.
Show child attributes
Show child attributes
The date and time when the meeting is scheduled to start, in ISO 8601 format.
The title of the meeting and calendar event.
The locale the meeting was booked with, used to determine date formatting in calendar event description.
The physical or virtual location where the meeting will take place.
The unique identifier for the web conference meeting.
The URL for accessing the meeting's web conference.
Was this page helpful?