younifyd
Menu

Post /scheduler/v3/meetings/meeting Links/book

Book a meeting

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

Use it in a workflow

  1. Add a step and choose the HubSpot connector.
  2. Pick the Post /scheduler/v3/meetings/meeting Links/book action (under Meetings).
  3. Fill in the fields below, then reference the result from later steps as {{postSchedulerV3MeetingsMeetingLinksBook.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

durationinteger (int64)required

The duration of the meeting in milliseconds.

emailstringrequired

The email address of the person booking the meeting.

firstNamestringrequired

The first name of the person booking the meeting.

formFieldsarray<object>required
namestringrequired

The name of the form field.

valuestringrequired

The value associated with the form field.

lastNamestringrequired

The last name of the person booking the meeting.

legalConsentResponsesarray<object>required
communicationTypeIdstringrequired

The ID of communication consent form being recorded.

consentedbooleanrequired

Whether the user has given consent for the specified communication type.

likelyAvailableUserIdsarray<string>required
localestring

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

slugstringrequired

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.

json
{
  "duration": 0,
  "email": "string",
  "firstName": "string",
  "formFields": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "lastName": "string",
  "legalConsentResponses": [
    {
      "communicationTypeId": "string",
      "consented": false
    }
  ],
  "likelyAvailableUserIds": [
    "string"
  ],
  "slug": "string",
  "startTime": "2025-01-01T00:00:00Z",
  "locale": "string",
  "timezone": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{postSchedulerV3MeetingsMeetingLinksBook.response.data.<field>}}.

bookingTimezonestring

The timezone the meeting was booked from.

calendarEventIdstring

The unique identifier for the meeting's calendar event.

contactIdstring

The ID of the contact associated to the meeting.

durationinteger (int64)

The duration of the meeting in milliseconds.

endstring (date-time)

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

formFieldsarray<object>
fieldTypestring

The specific input type of the form field. Corresponds to property types (e.g., `select`, `radio`, `date`, etc).

isCustombooleanrequired

Whether the form field is a custom field.

labelstringrequired

The text label associated with the form field.

namestringrequired

The name identifier for the form field, includes underscores in place of spaces (e.g., the label `my form` is converted to `my_form`).

translatedLabelstring

The translated text label for the form field.

valuestringrequired

The value associated with the form field.

valueLabelstring

The text label associated to a form field selection or option.

guestEmailsarray<string>
isOfflineboolean

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

legalConsentResponsesarray<object>
communicationTypeIdstringrequired

The ID of communication consent form being recorded.

consentedbooleanrequired

Whether the user has given consent for the specified communication type.

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)

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

subjectstring

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.

json
{
  "bookingTimezone": "string",
  "calendarEventId": "string",
  "contactId": "string",
  "duration": 0,
  "end": "2025-01-01T00:00:00Z",
  "formFields": [
    {
      "isCustom": false,
      "label": "string",
      "name": "string",
      "value": "string",
      "fieldType": "string",
      "translatedLabel": "string",
      "valueLabel": "string"
    }
  ],
  "guestEmails": [
    "string"
  ],
  "isOffline": false,
  "legalConsentResponses": [
    {
      "communicationTypeId": "string",
      "consented": false
    }
  ],
  "start": "2025-01-01T00:00:00Z",
  "subject": "string",
  "locale": "string"
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.