HubSpot: Scheduler schemas

← Scheduler operations · All 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 — 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

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 — 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.

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.

Create meeting — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
associations	array	Required within parent	An array of associations related to the meeting event, each represented by an ExternalAssociationCreateRequest object.
associations[]	Model	Each item	Expand Create meeting — request body — body associations item
emailReminderSchedule	Model	Required within parent	Expand Create meeting — request body — body email Reminder Schedule
properties	Model	Required within parent	Expand Create meeting — request body — body properties
timezone	string	Required within parent	A string representing the timezone in which the meeting event is scheduled.

Referenced models: Create meeting — request body — body associations item, Create meeting — request body — body properties, Create meeting — request body — body email Reminder Schedule

Create meeting — request body — body associations item

Field	Type	Presence	Description and constraints
$	object	Root
to	Model	Required within parent	Expand Create meeting — request body — body associations item to
types	array	Required within parent	An array of association specifications, detailing the types of associations to be created. Each item in the array is an object that defines the association type.
types[]	Model	Each item	Expand Create meeting — request body — body associations item types item

Referenced models: Create meeting — request body — body associations item types item, Create meeting — request body — body associations item to

Create meeting — request body — body associations item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	The unique identifier for the public object. It is a string that serves as a reference to the object within the API.

Create meeting — request body — body associations item types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
associationCategory	string	Required within parent	A string indicating the category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	integer	Required within parent	An integer representing the unique identifier for the type of association. Format: int32

Create meeting — request body — body email Reminder Schedule

Field	Type	Presence	Description and constraints
$	object	Root
reminders	array	Required within parent	An array of ExternalReminder objects that specify the timing and frequency of the email reminders.
reminders[]	Model	Each item	Expand Create meeting — request body — body email Reminder Schedule reminders item
shouldIncludeInviteDescription	boolean	Required within parent	A boolean indicating whether the invite description should be included in the email reminder.

Referenced models: Create meeting — request body — body email Reminder Schedule reminders item

Create meeting — request body — body email Reminder Schedule reminders item

Field	Type	Presence	Description and constraints
$	object	Root
numberOfTimeUnits	integer	Required within parent	The number of time units before the meeting when the reminder should be sent. This is an integer value. Format: int32
timeUnit	string	Required within parent	The unit of time for the reminder. Valid values include 'WEEKS', 'DAYS', 'HOURS', and 'MINUTES'. One of: DAYS, HOURS, MINUTES, WEEKS

Create meeting — request body — body properties

Field	Type	Presence	Description and constraints
$	object	Root
hs_activity_type	string	Optional	The type of activity for the meeting. This is a string value.
hs_attachment_ids	array	Optional	An array of strings representing the IDs of attachments associated with the meeting.
hs_attachment_ids[]	string	Each item
hs_attendee_owner_ids	array	Optional	An array of strings representing the IDs of the owners of the attendees for the meeting.
hs_attendee_owner_ids[]	string	Each item
hs_internal_meeting_notes	string	Optional	Internal notes for the meeting. This is a string value.
hs_meeting_body	string	Optional	The body content or description of the meeting. This is a string value.
hs_meeting_end_time	string	Required within parent	The end time of the meeting, in ISO 8601 format. Format: date-time
hs_meeting_location	string	Optional	The location of the meeting. This is a string value.
hs_meeting_location_type	string	Optional	The type of location for the meeting. Valid values include 'PHONE', 'ADDRESS', and 'CUSTOM'. One of: ADDRESS, CUSTOM, PHONE
hs_meeting_outcome	string	Required within parent	A string representing the outcome of the meeting.
hs_meeting_start_time	string	Required within parent	The start time of the meeting, in ISO 8601 format. Format: date-time
hs_meeting_title	string	Required within parent	The title of the meeting. This is a string value.
hs_timestamp	string	Required within parent	A timestamp indicating when the meeting event was created, in ISO 8601 format. Format: date-time
hubspot_owner_id	string	Required within parent	The unique identifier of the HubSpot owner associated with the meeting.

Create meeting — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the calendar meeting event was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the calendar meeting event.
lastUpdatedAt	string	Required within parent	The date and time when the calendar meeting event was last updated, in ISO 8601 format. Format: date-time
properties	Model	Required within parent	Expand Create meeting — response body — properties

Referenced models: Create meeting — response body — properties

Create meeting — response body — properties

Field	Type	Presence	Description and constraints
$	object	Root
hs_activity_type	string	Optional	The type of activity associated with the meeting.
hs_attachment_ids	array	Optional	An array of unique identifiers for attachments associated with the meeting.
hs_attachment_ids[]	string	Each item
hs_attendee_owner_ids	array	Optional	An array of unique identifiers for the owners of the attendees.
hs_attendee_owner_ids[]	string	Each item
hs_engagement_source	string	Required within parent	The source of the engagement. Valid values include a wide range of sources such as 'UNKNOWN', 'IMPORT', 'API', 'FORM', and many others. Known values: ACADEMY, ACCEPTANCE_TEST, ACTIVITY_AUTO_ASSOCIATE, ACTIVITY_LOG_REVERT, ADS, AI_GROUP, ANALYTICS, API, APPROVALS, ASSISTS, ASSOCIATIONS, AUTO_ASSOCIATE_BY_DOMAIN, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM, AVATARS_SERVICE, BATCH_UPDATE, BCC_TO_CRM, BEHAVIORAL_EVENTS, BET_ASSIGNMENT, BET_CRM_CONNECTOR, BIDEN, BILLING, BOT, BREEZE_AGENT, CALCULATED, CENTRAL_EXCHANGE_RATES, CHATSPOT, CLONE_OBJECTS, COMMUNICATOR, COMPANIES, COMPANY_FAMILIES, COMPANY_INSIGHTS, CONNECTED_ACCOUNT, CONTACTS, CONTACTS_WEB, CONTENT_MEMBERSHIP, CONVERSATIONAL_ENRICHMENT, CONVERSATIONS, CRM_PROCESSES_PLATFORM, CRM_UI, CRM_UI_BULK_ACTION, CUSTOMER_AGENT, CUSTOMER_PORTAL, DATA_ENRICHMENT, DATA_QUALITY, DATASET, DEALS, DEFAULT, DELETE_OBJECTS, DI_WRITE_TO_CRM, EMAIL, EMAIL_INBOX_IMPORT, EMAIL_INTEGRATION, ENGAGEMENTS, EXTENSION, FILE_MANAGER, FLYWHEEL_PRODUCT_DATA_SYNC, FORECASTING, FORM, FORWARD_TO_CRM, GMAIL_INTEGRATION, GOALS, HEISENBERG, HELP_DESK, HELP_DESK_AI, IMPORT, INTEGRATION, INTEGRATIONS_PLATFORM, INTEGRATIONS_SYNC, INTENT, INTERNAL_PROCESSING, LEADIN, LEGAL_BASIS_REMEDIATION, MARKET_SOURCING, MARKETPLACE, MARKETS, MEETINGS, MERGE_COMPANIES, MERGE_CONTACTS, MERGE_OBJECTS, MERGE_REVERT_OBJECTS, MICROAPPS, MIGRATION, MOBILE_ANDROID, MOBILE_IOS, PAYMENTS, PIPELINE_SETTINGS, PLAYBOOKS, PORTAL_OBJECT_SYNC, PORTAL_USER_ASSOCIATOR, PRESENTATIONS, PRIMARY_AUTOMATION, PROPERTY_DEFAULT_VALUE, PROPERTY_RESTORE, PROPERTY_SETTINGS, PROSPECTING_AGENT, QUOTAS, QUOTES, RECYCLING_BIN, RESTORE_OBJECTS, REVENUE_PLATFORM, SALES, SALES_MESSAGES, SALESFORCE, SEQUENCES, SETTINGS, SIDEKICK, SIGNALS, SLACK_INTEGRATION, SMART_DATA_CAPTURE, SOCIAL, SUCCESS, TALLY, TASK, UNKNOWN, WAL_INCREMENTAL, WORK_UI, WORKFLOW_CONTACT_DELETE_ACTION, WORKFLOWS
hs_engagement_source_id	string	Required within parent	The unique identifier for the source of the engagement.
hs_include_description_in_reminder	string	Optional	Indicates whether the meeting description should be included in reminders.
hs_internal_meeting_notes	string	Optional	Internal notes related to the meeting.
hs_meeting_body	string	Optional	The body or description of the meeting.
hs_meeting_end_time	string	Required within parent	The end time of the meeting, in ISO 8601 format. Format: date-time
hs_meeting_external_url	string	Optional	The external URL associated with the meeting.
hs_meeting_location	string	Optional	The location where the meeting is held.
hs_meeting_location_type	string	Optional	The type of location for the meeting. Valid values include 'PHONE', 'ADDRESS', and 'CUSTOM'. Known values: ADDRESS, CUSTOM, PHONE
hs_meeting_outcome	string	Required within parent	The outcome of the meeting.
hs_meeting_start_time	string	Required within parent	The start time of the meeting, in ISO 8601 format. Format: date-time
hs_meeting_title	string	Required within parent	The title of the meeting.
hs_timestamp	string	Required within parent	A timestamp indicating when the meeting event was recorded, in ISO 8601 format. Format: date-time
hs_unique_id	string	Optional	A unique identifier for the meeting event.
hubspot_owner_id	string	Optional	The unique identifier of the HubSpot owner associated with the meeting.

List Meeting Links — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Meeting Links — response body — paging
results	array	Required within parent	An array of external link metadata objects. Each object contains details about an external meeting link.
results[]	Model	Each item	Expand List Meeting Links — response body — results item
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The total number of external link metadata entries available. This is an integer value. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Meeting Links — response body — results item, List Meeting Links — response body — paging

List Meeting Links — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List Meeting Links — response body — paging next
prev	Model	Optional	Expand List Meeting Links — response body — paging prev

Referenced models: List Meeting Links — response body — paging next, List Meeting Links — response body — paging prev

List Meeting Links — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string representing the paging cursor token for the next set of results.
link	string	Optional	A string containing the URL link to the next page of results.

List Meeting Links — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token used to retrieve the previous page of results.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

List Meeting Links — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when the meeting link was created, in ISO 8601 format. Format: date-time
defaultLink	boolean	Required within parent	A boolean indicating whether this is the default meeting link.
id	string	Required within parent	The unique identifier for the meeting link.
link	string	Required within parent	The full URL of the meeting link.
name	string	Optional	The name of the meeting link.
organizerUserId	string	Required within parent	The unique identifier of the user who organized the meeting.
paymentLinkId	string	Optional	An integer representing the identifier for the payment link associated with the meeting.
slug	string	Required within parent	A string representing the unique part of the URL for the meeting link.
type	string	Required within parent	The type of meeting link. Valid values include 'PERSONAL_LINK', 'GROUP_CALENDAR', and 'ROUND_ROBIN_CALENDAR'. Known values: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR
updatedAt	string	Optional	The date and time when the meeting link was last updated, in ISO 8601 format. Format: date-time
userIdsOfLinkMembers	array	Required within parent	An array of user IDs representing the members associated with the meeting link.
userIdsOfLinkMembers[]	string	Each item

Retrieve availability — response body

Field	Type	Presence	Description and constraints
$	object	Root
allUsersBusyTimes	array	Required within parent	An array of objects representing the busy times for all users associated with the meeting link. Each object includes the user's busy time ranges.
allUsersBusyTimes[]	Model	Each item	Expand Retrieve availability — response body — all Users Busy Times item
linkAvailability	Model	Optional	Expand Retrieve availability — response body — link Availability

Referenced models: Retrieve availability — response body — link Availability, Retrieve availability — response body — all Users Busy Times item

Retrieve availability — response body — all Users Busy Times item

Field	Type	Presence	Description and constraints
$	object	Root
busyTimes	array	Required within parent	An array of time ranges during which the user is busy. Each time range is represented by an object with start and end times.
busyTimes[]	Model	Each item	Expand Retrieve availability — response body — all Users Busy Times item busy Times item
isOffline	boolean	Required within parent	A boolean indicating whether the user is currently offline.
meetingsUser	Model	Required within parent	Expand Retrieve availability — response body — all Users Busy Times item meetings User

Referenced models: Retrieve availability — response body — all Users Busy Times item meetings User, Retrieve availability — response body — all Users Busy Times item busy Times item

Retrieve availability — response body — all Users Busy Times item busy Times item

Field	Type	Presence	Description and constraints
$	object	Root
end	JSON	Required within parent
end (anyOf 1)	integer	Alternative	The end of the time range, represented as an integer in int64 format. Format: int64
end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start	JSON	Required within parent
start (anyOf 1)	integer	Alternative	The start of the time range, represented as an integer in int64 format. Format: int64
start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve availability — response body — all Users Busy Times item meetings User

Field	Type	Presence	Description and constraints
$	object	Root
calendarProvider	string	Required within parent	The calendar service provider used by the user. Valid values include 'GOOGLE', 'OFFICE365', 'EXCHANGE', and 'UNKNOWN'. Known values: EXCHANGE, GOOGLE, OFFICE365, UNKNOWN
id	string	Required within parent	The unique identifier for the meetings user.
isSalesStarter	boolean	Required within parent	A boolean indicating whether the user is a sales starter.
userId	string	Required within parent	The unique identifier for the user associated with the meetings service.
userProfile	Model	Required within parent	Expand Retrieve availability — response body — all Users Busy Times item meetings User user Profile

Referenced models: Retrieve availability — response body — all Users Busy Times item meetings User user Profile

Retrieve availability — response body — all Users Busy Times item meetings User user Profile

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email address of the user. This is a required string property.
firstName	string	Optional	The first name of the user. It is a string.
fullName	string	Optional	The full name of the user, combining first and last names. It is a string.
lastName	string	Optional	The last name of the user. It is a string.

Retrieve availability — response body — link Availability

Field	Type	Presence	Description and constraints
$	object	Root
hasMore	boolean	Required within parent	A boolean indicating whether there are more available meeting times beyond those currently provided.
linkAvailabilityByDuration	object	Required within parent	An object where each key is a duration and the value is an availability object for that duration. This provides detailed availability information for each specified meeting duration. Additional keys: see wildcard field
linkAvailabilityByDuration.*	Model	Additional keys	Expand Retrieve availability — response body — link Availability link Availability By Duration value

Referenced models: Retrieve availability — response body — link Availability link Availability By Duration value

Retrieve availability — response body — link Availability link Availability By Duration value

Field	Type	Presence	Description and constraints
$	object	Root
availabilities	array	Required within parent	An array of available time slots for the specified meeting duration. Each item in the array is an object representing a time slot's start and end times.
availabilities[]	Model	Each item	Expand Retrieve availability — response body — link Availability link Availability By Duration value availabilities item
meetingDurationMillis	JSON	Required within parent
meetingDurationMillis (anyOf 1)	integer	Alternative	The duration of the meeting in milliseconds. This is an integer value representing the length of the meeting. Format: int64
meetingDurationMillis (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve availability — response body — link Availability link Availability By Duration value availabilities item

Retrieve availability — response body — link Availability link Availability By Duration value availabilities item

Field	Type	Presence	Description and constraints
$	object	Root
endMillisUtc	JSON	Required within parent
endMillisUtc (anyOf 1)	integer	Alternative	The end time of the meeting availability, represented as a Unix timestamp in milliseconds. Format: int64
endMillisUtc (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startMillisUtc	JSON	Required within parent
startMillisUtc (anyOf 1)	integer	Alternative	The start time of the meeting availability, represented as a Unix timestamp in milliseconds. Format: int64
startMillisUtc (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve booking info — response body

Field	Type	Presence	Description and constraints
$	object	Root
allUsersBusyTimes	array	Required within parent	An array of objects representing the busy times for all users associated with the meeting link.
allUsersBusyTimes[]	Model	Each item	Expand Retrieve availability — response body — all Users Busy Times item
brandingMetadata	Model	Optional	Expand Retrieve booking info — response body — branding Metadata
customParams	Model	Required within parent	Expand Retrieve booking info — response body — custom Params
isOffline	boolean	Required within parent	A boolean indicating whether the meeting link is offline.
linkAvailability	Model	Optional	Expand Retrieve availability — response body — link Availability
linkId	string	Required within parent	The unique identifier for the meeting link.
linkType	string	Required within parent	The type of meeting link. Valid values include 'PERSONAL_LINK', 'GROUP_CALENDAR', and 'ROUND_ROBIN_CALENDAR'. Known values: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR

Referenced models: Retrieve booking info — response body — branding Metadata, Retrieve availability — response body — link Availability, Retrieve booking info — response body — custom Params, Retrieve availability — response body — all Users Busy Times item

Retrieve booking info — response body — branding Metadata

Field	Type	Presence	Description and constraints
$	object	Root
accent2Color	string	Optional	The second accent color used for branding, represented as a string.
accentColor	string	Optional	The accent color used for branding, represented as a string.
companyAddressLine1	string	Optional	The first line of the company's address.
companyAddressLine2	string	Optional	The second line of the company's address, if applicable.
companyAvatar	string	Optional	The URL of the company's avatar image.
companyCity	string	Optional	The city where the company is located.
companyCountry	string	Optional	The country where the company is located.
companyDomain	string	Optional	The domain of the company, typically used in URLs.
companyName	string	Optional	The name of the company.
companyState	string	Optional	The state or region where the company is located.
companyZip	string	Optional	The postal or ZIP code of the company's location.
logoAltText	string	Required within parent	The alternative text for the company logo, used for accessibility.
logoHeight	JSON	Optional
logoHeight (anyOf 1)	integer	Alternative	The height of the company logo in pixels. Format: int32
logoHeight (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
logoUrl	string	Optional	The URL of the company logo image.
logoWidth	JSON	Optional
logoWidth (anyOf 1)	integer	Alternative	The width of the company logo in pixels. Format: int32
logoWidth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
primaryColor	string	Optional	The primary color used for branding, represented as a string.
secondaryColor	string	Optional	The secondary color used for branding, represented as a string.
showMarketingAd	boolean	Required within parent	Indicates whether a marketing advertisement should be displayed. This is a boolean value.
showSalesAd	boolean	Required within parent	Indicates whether a sales advertisement should be displayed. This is a boolean value.

Retrieve booking info — response body — custom Params

Field	Type	Presence	Description and constraints
$	object	Root
availability	object	Required within parent	An object representing the availability settings for the meeting link, with additional properties for closed ranges. Additional keys: see wildcard field
availability.*	Model	Additional keys	Expand Retrieve booking info — response body — custom Params availability value
customAvailabilityEndDate	JSON	Optional
customAvailabilityEndDate (anyOf 1)	integer	Alternative	An integer representing the custom availability end date as a Unix timestamp in milliseconds. Format: int64
customAvailabilityEndDate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
customAvailabilityStartDate	JSON	Optional
customAvailabilityStartDate (anyOf 1)	integer	Alternative	An integer representing the custom availability start date as a Unix timestamp in milliseconds. Format: int64
customAvailabilityStartDate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
displayInfo	Model	Optional	Expand Retrieve booking info — response body — custom Params display Info
durations	array	Required within parent	An array of integers representing the possible durations for meetings in milliseconds.
durations[]	JSON	Each item
durations[] (anyOf 1)	integer	Alternative	Format: int64
durations[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
formFields	array	Required within parent	An array of form fields that are included in the meeting link form.
formFields[]	Model	Each item	Expand Retrieve booking info — response body — custom Params form Fields item
guestSettings	Model	Optional	Expand Retrieve booking info — response body — custom Params guest Settings
language	string	Optional	A string representing the language setting for the meeting link.
legalConsentEnabled	boolean	Required within parent	A boolean indicating whether legal consent is required for the meeting link.
legalConsentOptions	Model	Optional	Expand Retrieve booking info — response body — custom Params legal Consent Options
locale	string	Optional	A string representing the locale setting for the meeting link.
location	string	Optional	A string representing the location information for the meeting.
meetingBufferTime	JSON	Required within parent
meetingBufferTime (anyOf 1)	integer	Alternative	An integer representing the buffer time between meetings in milliseconds. Format: int64
meetingBufferTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ownerPrioritized	boolean	Required within parent	A boolean indicating whether the meeting owner is prioritized in scheduling.
redirectUrl	string	Optional	A string representing the URL to which users are redirected after booking a meeting.
startTimeIncrementMinutes	string	Required within parent	A string indicating the increment for start times, with valid values including 'MEETING_DURATION', 'FIVE', 'TEN', 'FIFTEEN', 'TWENTY', 'THIRTY', 'FORTY_FIVE', 'SIXTY', 'NINETY', and 'ONE_HUNDRED_TWENTY'. Known values: FIFTEEN, FIVE, FORTY_FIVE, MEETING_DURATION, NINETY, ONE_HUNDRED_TWENTY, SIXTY, TEN, THIRTY, TWENTY
weeksToAdvertise	JSON	Required within parent
weeksToAdvertise (anyOf 1)	integer	Alternative	An integer representing the number of weeks to advertise the meeting link. Format: int32
weeksToAdvertise (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
welcomeScreenInfo	Model	Optional	Expand Retrieve booking info — response body — custom Params welcome Screen Info

Referenced models: Retrieve booking info — response body — custom Params welcome Screen Info, Retrieve booking info — response body — custom Params availability value, Retrieve booking info — response body — custom Params guest Settings, Retrieve booking info — response body — custom Params legal Consent Options, Retrieve booking info — response body — custom Params display Info, Retrieve booking info — response body — custom Params form Fields item

Retrieve booking info — response body — custom Params availability value

Field	Type	Presence	Description and constraints
$	object	Root
end	JSON	Required within parent
end (anyOf 1)	integer	Alternative	The ending point of the range, represented as an integer in int64 format. Format: int64
end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start	JSON	Required within parent
start (anyOf 1)	integer	Alternative	The starting point of the range, represented as an integer in int64 format. Format: int64
start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve booking info — response body — custom Params display Info

Field	Type	Presence	Description and constraints
$	object	Root
avatar	string	Optional	A string representing the URL of the avatar image to be displayed.
companyAvatar	string	Optional	A string representing the URL of the company avatar image to be displayed.
headline	string	Optional	A string representing the headline text to be displayed with the meeting link.
publicDisplayAvatarOption	string	Optional	A string indicating the avatar display option, with valid values including 'PROFILE_IMAGE', 'COMPANY_LOGO', and 'CUSTOM_AVATAR'. Known values: COMPANY_LOGO, CUSTOM_AVATAR, PROFILE_IMAGE

Retrieve booking info — response body — custom Params form Fields item

Field	Type	Presence	Description and constraints
$	object	Root
fieldType	string	Required within parent	The type of the form field, represented as a string, indicating the kind of input expected.
isCustom	boolean	Required within parent	A boolean indicating whether the form field is a custom field defined by the user.
isRequired	boolean	Required within parent	A boolean indicating whether the form field is mandatory for the user to fill out.
label	string	Required within parent	The display label for the form field, shown to users, represented as a string.
name	string	Required within parent	The unique name identifier for the form field, represented as a string.
options	array	Required within parent	An array of options available for the form field, applicable if the field type supports multiple choices.
options[]	Model	Each item	Expand Retrieve booking info — response body — custom Params form Fields item options item
type	string	Required within parent	The specific data type of the form field, represented as a string.

Referenced models: Retrieve booking info — response body — custom Params form Fields item options item

Retrieve booking info — response body — custom Params form Fields item options item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Required within parent	A string providing a detailed description of the option.
displayOrder	JSON	Required within parent
displayOrder (anyOf 1)	integer	Alternative	An integer indicating the order in which the option should be displayed relative to other options. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
doubleData	JSON	Required within parent
doubleData (anyOf 1)	number	Alternative	A number that may hold additional data associated with the option.
doubleData (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hidden	boolean	Required within parent	A boolean indicating whether the option is hidden from display.
label	string	Required within parent	A string representing the display name of the option.
readOnly	boolean	Required within parent	A boolean indicating whether the option is read-only and cannot be modified.
value	string	Required within parent	A string representing the internal value associated with the option.

Retrieve booking info — response body — custom Params guest Settings

Field	Type	Presence	Description and constraints
$	object	Root
canAddGuests	boolean	Required within parent	A boolean indicating whether guests can be added to the meeting.
maxGuestCount	JSON	Required within parent
maxGuestCount (anyOf 1)	integer	Alternative	An integer specifying the maximum number of guests that can be added to the meeting. Format: int32
maxGuestCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve booking info — response body — custom Params legal Consent Options

Field	Type	Presence	Description and constraints
$	object	Root
communicationConsentCheckboxes	array	Required within parent	An array of communication consent checkboxes, each defined by an ExternalCommunicationConsentCheckbox object.
communicationConsentCheckboxes[]	Model	Each item	Expand Retrieve booking info — response body — custom Params legal Consent Options communication Consent Checkboxes item
communicationConsentText	string	Required within parent	A string containing the text for communication consent.
isLegitimateInterest	boolean	Required within parent	A boolean indicating whether legitimate interest is applicable.
legitimateInterestLegalBasis	string	Optional	A string indicating the legal basis for legitimate interest. Valid values include 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'. Known values: CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE
legitimateInterestSubscriptionTypes	array	Required within parent	An array of integers representing the subscription types that fall under legitimate interest.
legitimateInterestSubscriptionTypes[]	JSON	Each item
legitimateInterestSubscriptionTypes[] (anyOf 1)	integer	Alternative	Format: int64
legitimateInterestSubscriptionTypes[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
privacyPolicyText	string	Required within parent	A string containing the text for the privacy policy.
processingConsentCheckboxLabel	string	Required within parent	A string representing the label for the processing consent checkbox.
processingConsentFooterText	string	Required within parent	A string containing the footer text for processing consent.
processingConsentText	string	Required within parent	A string containing the text for processing consent.
processingConsentType	string	Required within parent	A string indicating the type of processing consent. Valid values are 'IMPLICIT' and 'REQUIRED_CHECKBOX'. Known values: IMPLICIT, REQUIRED_CHECKBOX

Referenced models: Retrieve booking info — response body — custom Params legal Consent Options communication Consent Checkboxes item

Retrieve booking info — response body — custom Params legal Consent Options communication Consent Checkboxes 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 this checkbox pertains to.
label	string	Required within parent	A string that contains the text label displayed next to the checkbox, describing the communication type or purpose.
required	boolean	Required within parent	A boolean indicating whether this checkbox must be checked by the user to proceed, signifying mandatory consent.

Retrieve booking info — response body — custom Params welcome Screen Info

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A descriptive text shown on the welcome screen. It is a string value.
logoUrl	string	Optional	The URL of the logo image displayed on the welcome screen. It is a string value.
showWelcomeScreen	boolean	Optional	A boolean indicating whether the welcome screen should be displayed to users.
title	string	Optional	The title displayed on the welcome screen. It is a string value.
useCompanyLogo	boolean	Optional	A boolean indicating whether the company's logo should be used on the welcome screen.