{ "openapi" : "3.0.1", "info" : { "title" : "Scheduler Meetings", "description" : "Meetings Service For HubSpot Sales", "version" : "v3", "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" }, "x-hubspot-related-documentation" : [ { "name" : "Meetings guide", "url" : "https://developers.hubspot.com/docs/reference/api/crm/engagements/meetings" } ] }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Advanced" }, { "name" : "Basic" } ], "paths" : { "/scheduler/v3/meetings/calendar" : { "post" : { "tags" : [ "Advanced" ], "summary" : "Create a new calendar meeting event.", "description" : "Create a new calendar event and meeting object by providing the necessary details such as associations, email reminders, meeting object properties, and timezone.", "operationId" : "post-/scheduler/v3/meetings/calendar", "parameters" : [ { "name" : "organizerUserId", "in" : "query", "description" : "", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalCalendarMeetingEventCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalCalenderMeetingEventResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "deprecated" : true, "security" : [ { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.schemas.meetings.write" ] } ], "x-hubspot-user-level-auth" : { "internalOnly" : false } } }, "/scheduler/v3/meetings/meeting-links" : { "get" : { "tags" : [ "Basic" ], "summary" : "Get meeting scheduling pages", "description" : "Get a paged list meeting scheduling pages", "operationId" : "get-/scheduler/v3/meetings/meeting-links", "parameters" : [ { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null } }, { "name" : "name", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "organizerUserId", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "type", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null, "enum" : [ "GROUP_CALENDAR", "PERSONAL_LINK", "ROUND_ROBIN_CALENDAR" ] } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalExternalLinkMetadata" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "deprecated" : true, "security" : [ { "oauth2" : [ "scheduler.meetings.meeting-link.read" ] } ], "x-hubspot-user-level-auth" : { "internalOnly" : false } } }, "/scheduler/v3/meetings/meeting-links/book" : { "post" : { "tags" : [ "Advanced" ], "summary" : "Book a meeting\n", "description" : "Book a meeting for a specified meeting page.", "operationId" : "post-/scheduler/v3/meetings/meeting-links/book", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalMeetingBooking" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalMeetingBookingResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "deprecated" : true, "security" : [ { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.schemas.meetings.write" ] } ], "x-hubspot-user-level-auth" : { "internalOnly" : false } } }, "/scheduler/v3/meetings/meeting-links/book/availability-page/{slug}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Get the availability for a meeting", "description" : "Get the next availability times for a meeting page.", "operationId" : "get-/scheduler/v3/meetings/meeting-links/book/availability-page/{slug}", "parameters" : [ { "name" : "slug", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "timezone", "in" : "query", "description" : "", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "monthOffset", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalLinkAvailabilityAndBusyTimes" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "deprecated" : true, "security" : [ { "oauth2" : [ "scheduler.meetings.meeting-link.read" ] } ], "x-hubspot-user-level-auth" : { "internalOnly" : false } } }, "/scheduler/v3/meetings/meeting-links/book/{slug}" : { "get" : { "tags" : [ "Basic" ], "summary" : "List booking information", "description" : "Get details about the initial information necessary for a meeting scheduler.", "operationId" : "get-/scheduler/v3/meetings/meeting-links/book/{slug}", "parameters" : [ { "name" : "slug", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "timezone", "in" : "query", "description" : "", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalBookingInfo" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "deprecated" : true, "security" : [ { "oauth2" : [ "scheduler.meetings.meeting-link.read" ] } ], "x-hubspot-user-level-auth" : { "internalOnly" : false } } }, "/scheduler/v3/meetings/meeting-links/{meetingLinkSlug}" : { "patch" : { "tags" : [ "Basic" ], "operationId" : "patch-/scheduler/v3/meetings/meeting-links/{meetingLinkSlug}_/scheduler/v3/meetings/meeting-links/{meetingLinkSlug}", "parameters" : [ { "name" : "meetingLinkSlug", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalMeetingsLinkUpdateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalLinkMetadata" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "deprecated" : true, "security" : [ { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.schemas.meetings.write" ] } ], "x-hubspot-user-level-auth" : { "internalOnly" : false } } } }, "components" : { "schemas" : { "AssociationSpec" : { "required" : [ "associationCategory", "associationTypeId" ], "type" : "object", "properties" : { "associationCategory" : { "type" : "string", "description" : "The category of the association, such as \"HUBSPOT_DEFINED\".", "example" : null, "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the specific type of association.", "format" : "int32", "example" : null } }, "description" : "Defines the type, direction, and details of the relationship between two CRM objects.", "example" : null }, "CollectionResponseWithTotalExternalLinkMetadata" : { "required" : [ "results", "total" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalLinkMetadata" } }, "total" : { "type" : "integer", "format" : "int32", "example" : null } }, "example" : null }, "Error" : { "required" : [ "category", "correlationId", "message" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The error category", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" }, "correlationId" : { "type" : "string", "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", "format" : "uuid", "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" }, "errors" : { "type" : "array", "description" : "further information about the error", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : "An error occurred" }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", "example" : { "message" : "Invalid input (details will vary based on the error)", "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", "category" : "VALIDATION_ERROR", "links" : { "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" } } }, "ErrorDetail" : { "required" : [ "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The status code associated with the error detail", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{missingScopes=[scope1, scope2]}" }, "in" : { "type" : "string", "description" : "The name of the field or parameter in which the error was found.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : null }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.", "example" : null }, "ExternalAssociationCreateRequest" : { "required" : [ "to", "types" ], "type" : "object", "properties" : { "to" : { "$ref" : "#/components/schemas/PublicObjectId" }, "types" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/AssociationSpec" } } }, "example" : null }, "ExternalBookingFormField" : { "required" : [ "name", "value" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the form field.", "example" : null }, "value" : { "type" : "string", "description" : "The value associated with the form field.", "example" : null } }, "example" : null }, "ExternalBookingInfo" : { "required" : [ "allUsersBusyTimes", "customParams", "isOffline", "linkId", "linkType" ], "type" : "object", "properties" : { "allUsersBusyTimes" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalUserBusyTimes" } }, "brandingMetadata" : { "$ref" : "#/components/schemas/ExternalBrandingMetadata" }, "customParams" : { "$ref" : "#/components/schemas/ExternalMeetingsLinkSettings" }, "isOffline" : { "type" : "boolean", "description" : "Whether the meeting was booked offline, meaning no associated calendar event was created.", "example" : null }, "linkAvailability" : { "$ref" : "#/components/schemas/ExternalLinkAvailability" }, "linkId" : { "type" : "string", "description" : "The unique identifier for the meeting link.", "example" : null }, "linkType" : { "type" : "string", "description" : "The type of the meeting link. Accepted values are: GROUP_CALENDAR, PERSONAL_LINK, ROUND_ROBIN_CALENDAR.", "example" : null, "enum" : [ "GROUP_CALENDAR", "PERSONAL_LINK", "ROUND_ROBIN_CALENDAR" ] } }, "example" : null }, "ExternalBrandingMetadata" : { "required" : [ "logoAltText", "showMarketingAd", "showSalesAd" ], "type" : "object", "properties" : { "accent2Color" : { "type" : "string", "description" : "The secondary accent color used in branding.", "example" : null }, "accentColor" : { "type" : "string", "description" : "The primary accent color used in branding.", "example" : null }, "companyAddressLine1" : { "type" : "string", "description" : "The first line of the company's address.", "example" : null }, "companyAddressLine2" : { "type" : "string", "description" : "The second line of the company's address.", "example" : null }, "companyAvatar" : { "type" : "string", "description" : "The URL of the company's avatar image.", "example" : null }, "companyCity" : { "type" : "string", "description" : "The city where the company is located.", "example" : null }, "companyCountry" : { "type" : "string", "description" : "The country where the company is located.", "example" : null }, "companyDomain" : { "type" : "string", "description" : "The domain of the company's website.", "example" : null }, "companyName" : { "type" : "string", "description" : "The name of the company.", "example" : null }, "companyState" : { "type" : "string", "description" : "The state where the company is located.", "example" : null }, "companyZip" : { "type" : "string", "description" : "The ZIP code of the company's location.", "example" : null }, "logoAltText" : { "type" : "string", "description" : "The alternative text for the current logo.", "example" : null }, "logoHeight" : { "type" : "integer", "description" : "The height of the logo in pixels.", "format" : "int32", "example" : null }, "logoUrl" : { "type" : "string", "description" : "The URL of a custom logo image.", "example" : null }, "logoWidth" : { "type" : "integer", "description" : "The width of the logo in pixels.", "format" : "int32", "example" : null }, "primaryColor" : { "type" : "string", "description" : "The primary color used in branding.", "example" : null }, "secondaryColor" : { "type" : "string", "description" : "The secondary color used in branding.", "example" : null }, "showMarketingAd" : { "type" : "boolean", "description" : "Whether Hubspot Marketing ads are shown.", "example" : null }, "showSalesAd" : { "type" : "boolean", "description" : "Whether Hubspot Sales ads are shown.", "example" : null } }, "example" : null }, "ExternalCalendarMeetingEventCreateProperties" : { "required" : [ "hs_meeting_end_time", "hs_meeting_outcome", "hs_meeting_start_time", "hs_meeting_title", "hs_timestamp", "hubspot_owner_id" ], "type" : "object", "properties" : { "hs_activity_type" : { "type" : "string", "description" : "The activity type of the meeting. Acceptable values are based on portal defined call and meeting types.", "example" : null }, "hs_attachment_ids" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "hs_attendee_owner_ids" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "hs_internal_meeting_notes" : { "type" : "string", "description" : "Internal notes related to the meeting.", "example" : null }, "hs_meeting_body" : { "type" : "string", "description" : "The description of the meeting and calendar event.", "example" : null }, "hs_meeting_end_time" : { "type" : "string", "description" : "The time that the meeting should end in ISO 8601 format.", "format" : "date-time", "example" : null }, "hs_meeting_location" : { "type" : "string", "description" : "The physical address, virtual location, or phone number where the meeting will take place.", "example" : null }, "hs_meeting_location_type" : { "type" : "string", "description" : "The type of location for the meeting. Acceptable values are: ADDRESS, CUSTOM, PHONE.", "example" : null, "enum" : [ "ADDRESS", "CUSTOM", "PHONE" ] }, "hs_meeting_outcome" : { "type" : "string", "description" : "The outcome of the meeting. Acceptable default values are: SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, CANCELED. This property can be changed to include additional custom values.", "example" : null }, "hs_meeting_start_time" : { "type" : "string", "description" : "The time that the meeting should start in ISO 8601 format.", "format" : "date-time", "example" : null }, "hs_meeting_title" : { "type" : "string", "description" : "The title of the meeting and calendar event.", "example" : null }, "hs_timestamp" : { "type" : "string", "description" : "The time that the meeting should start in ISO 8601 format. This value should be the same as `hs_meeting_start_time`.", "format" : "date-time", "example" : null }, "hubspot_owner_id" : { "type" : "string", "description" : "The ownerId of the HubSpot user who will host the meeting.", "example" : null } }, "example" : null }, "ExternalCalendarMeetingEventCreateRequest" : { "required" : [ "associations", "emailReminderSchedule", "properties", "timezone" ], "type" : "object", "properties" : { "associations" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalAssociationCreateRequest" } }, "emailReminderSchedule" : { "$ref" : "#/components/schemas/ExternalEmailReminderSchedule" }, "properties" : { "$ref" : "#/components/schemas/ExternalCalendarMeetingEventCreateProperties" }, "timezone" : { "type" : "string", "description" : "The timezone property that will be set on the meeting event.", "example" : null } }, "example" : null }, "ExternalCalendarMeetingEventResponseProperties" : { "required" : [ "hs_engagement_source", "hs_engagement_source_id", "hs_meeting_end_time", "hs_meeting_outcome", "hs_meeting_start_time", "hs_meeting_title", "hs_timestamp" ], "type" : "object", "properties" : { "hs_activity_type" : { "type" : "string", "description" : "The activity type of the meeting. Acceptable values are based on portal defined call and meeting types.", "example" : null }, "hs_attachment_ids" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "hs_attendee_owner_ids" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "hs_engagement_source" : { "type" : "string", "description" : "The source of the engagement, will always be `MEETINGS`.", "example" : null, "enum" : [ "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" : { "type" : "string", "description" : "The ID associated with the process created the engagement. Should always be empty when creating meeting events through this API.", "example" : null }, "hs_include_description_in_reminder" : { "type" : "string", "description" : "Whether to include the meeting description in the reminder.", "example" : null }, "hs_internal_meeting_notes" : { "type" : "string", "description" : "Internal notes related to the meeting.", "example" : null }, "hs_meeting_body" : { "type" : "string", "description" : "The description of the meeting and calendar event.", "example" : null }, "hs_meeting_end_time" : { "type" : "string", "description" : "The end time of the meeting in ISO 8601 format.", "format" : "date-time", "example" : null }, "hs_meeting_external_url" : { "type" : "string", "description" : "The calendar event URL for the meeting.", "example" : null }, "hs_meeting_location" : { "type" : "string", "description" : "The physical address, virtual location, or phone number where the meeting will take place.", "example" : null }, "hs_meeting_location_type" : { "type" : "string", "description" : "The type of location for the meeting. Acceptable values are: ADDRESS, CUSTOM, PHONE.", "example" : null, "enum" : [ "ADDRESS", "CUSTOM", "PHONE" ] }, "hs_meeting_outcome" : { "type" : "string", "description" : "The outcome of the meeting. Acceptable default values are: SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, CANCELED. This property can be changed to include additional custom values.", "example" : null }, "hs_meeting_start_time" : { "type" : "string", "description" : "The start time of the meeting in ISO 8601 format.", "format" : "date-time", "example" : null }, "hs_meeting_title" : { "type" : "string", "description" : "The title of the meeting and calendar event.", "example" : null }, "hs_timestamp" : { "type" : "string", "description" : "The time that the meeting should start in ISO 8601 format. This value should be the same as `hs_meeting_start_time`.", "format" : "date-time", "example" : null }, "hs_unique_id" : { "type" : "string", "description" : "The unique ID of the created calendar event.", "example" : null }, "hubspot_owner_id" : { "type" : "string", "description" : "The owner ID of the HubSpot user hosting the meeting.", "example" : null } }, "example" : null }, "ExternalCalenderMeetingEventResponse" : { "required" : [ "createdAt", "id", "lastUpdatedAt", "properties" ], "type" : "object", "properties" : { "createdAt" : { "type" : "string", "description" : "The date and time when the meeting event was initially created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the meeting event.", "example" : null }, "lastUpdatedAt" : { "type" : "string", "description" : "The date and time when the meeting event was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "properties" : { "$ref" : "#/components/schemas/ExternalCalendarMeetingEventResponseProperties" } }, "example" : null }, "ExternalClosedRange" : { "required" : [ "end", "start" ], "type" : "object", "properties" : { "end" : { "type" : "integer", "description" : "The end value of the closed range, represented as an integer.", "format" : "int64", "example" : null }, "start" : { "type" : "integer", "description" : "The start value of the closed range, represented as an integer.", "format" : "int64", "example" : null } }, "example" : null }, "ExternalCommunicationConsentCheckbox" : { "required" : [ "communicationTypeId", "label", "required" ], "type" : "object", "properties" : { "communicationTypeId" : { "type" : "string", "description" : "The ID of the communication consent form being recorded.", "example" : null }, "label" : { "type" : "string", "description" : "The text label describing the consent being given.", "example" : null }, "required" : { "type" : "boolean", "description" : "Whether the consent checkbox is required.", "example" : null } }, "example" : null }, "ExternalEmailReminderSchedule" : { "required" : [ "reminders", "shouldIncludeInviteDescription" ], "type" : "object", "properties" : { "reminders" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalReminder" } }, "shouldIncludeInviteDescription" : { "type" : "boolean", "description" : "Whether the invite description should be included in the reminder.", "example" : null } }, "example" : null }, "ExternalGuestSettings" : { "required" : [ "canAddGuests", "maxGuestCount" ], "type" : "object", "properties" : { "canAddGuests" : { "type" : "boolean", "description" : "Indicates whether guests can be added to the meeting.", "example" : null }, "maxGuestCount" : { "type" : "integer", "description" : "The maximum number of guests that can be added to the meeting.", "format" : "int32", "example" : null } }, "example" : null }, "ExternalLegalConsentOptions" : { "required" : [ "communicationConsentCheckboxes", "communicationConsentText", "isLegitimateInterest", "legitimateInterestSubscriptionTypes", "privacyPolicyText", "processingConsentCheckboxLabel", "processingConsentFooterText", "processingConsentText", "processingConsentType" ], "type" : "object", "properties" : { "communicationConsentCheckboxes" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalCommunicationConsentCheckbox" } }, "communicationConsentText" : { "type" : "string", "description" : "The text that describes the consent for communication preferences.", "example" : null }, "isLegitimateInterest" : { "type" : "boolean", "description" : "Whether the legal basis for processing is legitimate interest.", "example" : null }, "legitimateInterestLegalBasis" : { "type" : "string", "description" : "The legal basis for processing under legitimate interest. Accepted values are: LEGITIMATE_INTEREST_PQL, LEGITIMATE_INTEREST_CLIENT, PERFORMANCE_OF_CONTRACT, CONSENT_WITH_NOTICE, NON_GDPR, PROCESS_AND_STORE, LEGITIMATE_INTEREST_OTHER.", "example" : null, "enum" : [ "CONSENT_WITH_NOTICE", "LEGITIMATE_INTEREST_CLIENT", "LEGITIMATE_INTEREST_OTHER", "LEGITIMATE_INTEREST_PQL", "NON_GDPR", "PERFORMANCE_OF_CONTRACT", "PROCESS_AND_STORE" ] }, "legitimateInterestSubscriptionTypes" : { "type" : "array", "example" : null, "items" : { "type" : "integer", "format" : "int64", "example" : null } }, "privacyPolicyText" : { "type" : "string", "description" : "The text that describes the data processing privacy policy.", "example" : null }, "processingConsentCheckboxLabel" : { "type" : "string", "description" : "The label for the checkbox used to obtain consent for data processing.", "example" : null }, "processingConsentFooterText" : { "type" : "string", "description" : "The footer text accompanying the consent for data processing. This field is not used by the meeting platform and will always be empty.", "example" : null }, "processingConsentText" : { "type" : "string", "description" : "The text that describes the consent for processing personal data.", "example" : null }, "processingConsentType" : { "type" : "string", "description" : "The type of consent required for processing. Accepted values are: IMPLICIT, REQUIRED_CHECKBOX.", "example" : null, "enum" : [ "IMPLICIT", "REQUIRED_CHECKBOX" ] } }, "example" : null }, "ExternalLegalConsentResponse" : { "required" : [ "communicationTypeId", "consented" ], "type" : "object", "properties" : { "communicationTypeId" : { "type" : "string", "description" : "The ID of communication consent form being recorded.", "example" : null }, "consented" : { "type" : "boolean", "description" : "Whether the user has given consent for the specified communication type.", "example" : null } }, "example" : null }, "ExternalLinkAvailability" : { "required" : [ "hasMore", "linkAvailabilityByDuration" ], "type" : "object", "properties" : { "hasMore" : { "type" : "boolean", "description" : "Whether there are more available meeting times beyond the returned set.", "example" : null }, "linkAvailabilityByDuration" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ExternalLinkAvailabilityForDuration" }, "description" : "Available booking slots for the meeting, grouped by the duration.", "example" : null } }, "example" : null }, "ExternalLinkAvailabilityAndBusyTimes" : { "required" : [ "allUsersBusyTimes" ], "type" : "object", "properties" : { "allUsersBusyTimes" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalUserBusyTimes" } }, "linkAvailability" : { "$ref" : "#/components/schemas/ExternalLinkAvailability" } }, "example" : null }, "ExternalLinkAvailabilityForDuration" : { "required" : [ "availabilities", "meetingDurationMillis" ], "type" : "object", "properties" : { "availabilities" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalMeetingAvailability" } }, "meetingDurationMillis" : { "type" : "integer", "description" : "The duration of the meeting in milliseconds.", "format" : "int64", "example" : null } }, "example" : null }, "ExternalLinkDisplayInfo" : { "type" : "object", "properties" : { "avatar" : { "type" : "string", "description" : "The URL of the user's custom uploaded avatar image.", "example" : null }, "companyAvatar" : { "type" : "string", "description" : "The URL of the company's avatar image.", "example" : null }, "headline" : { "type" : "string", "description" : "Deprecated field with no impact of link display info.", "example" : null }, "publicDisplayAvatarOption" : { "type" : "string", "description" : "Option for determining which avatar to display on scheduling page. Accepted values are: PROFILE_IMAGE, COMPANY_LOGO, CUSTOM_AVATAR,", "example" : null, "enum" : [ "COMPANY_LOGO", "CUSTOM_AVATAR", "PROFILE_IMAGE" ] } }, "example" : null }, "ExternalLinkFormField" : { "required" : [ "fieldType", "isCustom", "isRequired", "label", "name", "options", "type" ], "type" : "object", "properties" : { "fieldType" : { "type" : "string", "description" : "The specific field type of the form field. Corresponds to property types (e.g., `select`, `radio`, `date`, etc)", "example" : null }, "isCustom" : { "type" : "boolean", "description" : "Whether the form field is a custom field.", "example" : null }, "isRequired" : { "type" : "boolean", "description" : "Whether the form field is mandatory.", "example" : null }, "label" : { "type" : "string", "description" : "The text label for the form field.", "example" : null }, "name" : { "type" : "string", "description" : "The name identifier for the form field.", "example" : null }, "options" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalOption" } }, "type" : { "type" : "string", "description" : "The data type of the form field accepts (e.g. `date`, `enumeration`, etc)", "example" : null } }, "example" : null }, "ExternalLinkMetadata" : { "required" : [ "createdAt", "defaultLink", "id", "link", "organizerUserId", "slug", "type", "userIdsOfLinkMembers" ], "type" : "object", "properties" : { "createdAt" : { "type" : "string", "description" : "The Unix time in milliseconds when the meeting link was created.", "format" : "date-time", "example" : null }, "defaultLink" : { "type" : "boolean", "description" : "Whether the meeting link is the user's default link.", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the meeting link.", "example" : null }, "link" : { "type" : "string", "description" : "The URL of the meeting link.", "example" : null }, "name" : { "type" : "string", "description" : "The name of the meeting link.", "example" : null }, "organizerUserId" : { "type" : "string", "description" : "The user ID of the meeting link's organizer.", "example" : null }, "paymentLinkId" : { "type" : "string", "example" : null }, "slug" : { "type" : "string", "description" : "The slug of the meeting link, located directly after the domain in the URL.", "example" : null }, "type" : { "type" : "string", "description" : "The type of the external meeting link. Accepted values are: PERSONAL_LINK, GROUP_CALENDAR, ROUND_ROBIN_CALENDAR.", "example" : null, "enum" : [ "GROUP_CALENDAR", "PERSONAL_LINK", "ROUND_ROBIN_CALENDAR" ] }, "updatedAt" : { "type" : "string", "description" : "The Unix time in milliseconds when the meeting link was last updated.", "format" : "date-time", "example" : null }, "userIdsOfLinkMembers" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, "example" : null }, "ExternalMeetingAvailability" : { "required" : [ "endMillisUtc", "startMillisUtc" ], "type" : "object", "properties" : { "endMillisUtc" : { "type" : "integer", "description" : "The end time of the meeting availability, represented as Unix time in milliseconds.", "format" : "int64", "example" : null }, "startMillisUtc" : { "type" : "integer", "description" : "The start time of the meeting availability, represented as Unix time in milliseconds.", "format" : "int64", "example" : null } }, "example" : null }, "ExternalMeetingBooking" : { "required" : [ "duration", "email", "firstName", "formFields", "lastName", "legalConsentResponses", "likelyAvailableUserIds", "slug", "startTime" ], "type" : "object", "properties" : { "duration" : { "type" : "integer", "description" : "The duration of the meeting in milliseconds.", "format" : "int64", "example" : null }, "email" : { "type" : "string", "description" : "The email address of the person booking the meeting.", "example" : null }, "firstName" : { "type" : "string", "description" : "The first name of the person booking the meeting.", "example" : null }, "formFields" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalBookingFormField" } }, "lastName" : { "type" : "string", "description" : "The last name of the person booking the meeting.", "example" : null }, "legalConsentResponses" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalLegalConsentResponse" } }, "likelyAvailableUserIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "locale" : { "type" : "string", "description" : "The locale used for formatting dates and times in the meeting booking.", "example" : null }, "slug" : { "type" : "string", "description" : "The unique path identifier for the meeting page.", "example" : null }, "startTime" : { "type" : "string", "description" : "The date and time when the meeting is scheduled to start, in ISO 8601 format.", "format" : "date-time", "example" : null }, "timezone" : { "type" : "string", "description" : "The timezone in which the meeting is scheduled.", "example" : null } }, "example" : null }, "ExternalMeetingBookingResponse" : { "required" : [ "bookingTimezone", "calendarEventId", "contactId", "duration", "end", "formFields", "guestEmails", "isOffline", "legalConsentResponses", "start", "subject" ], "type" : "object", "properties" : { "bookingTimezone" : { "type" : "string", "description" : "The timezone the meeting was booked from.", "example" : null }, "calendarEventId" : { "type" : "string", "description" : "The unique identifier for the meeting's calendar event.", "example" : null }, "contactId" : { "type" : "string", "description" : "The ID of the contact associated to the meeting.", "example" : null }, "duration" : { "type" : "integer", "description" : "The duration of the meeting in milliseconds.", "format" : "int64", "example" : null }, "end" : { "type" : "string", "description" : "The date and time when the meeting is scheduled to end, in ISO 8601 format.", "format" : "date-time", "example" : null }, "formFields" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalValidatedFormField" } }, "guestEmails" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "isOffline" : { "type" : "boolean", "description" : "Whether the meeting was booked offline and no associated calendar event was created.", "example" : null }, "legalConsentResponses" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalLegalConsentResponse" } }, "locale" : { "type" : "string", "description" : "The locale the meeting was booked with, used to determine date formatting in calendar event description.", "example" : null }, "location" : { "type" : "string", "description" : "The physical or virtual location where the meeting will take place.", "example" : null }, "start" : { "type" : "string", "description" : "The date and time when the meeting is scheduled to start, in ISO 8601 format.", "format" : "date-time", "example" : null }, "subject" : { "type" : "string", "description" : "The title of the meeting and calendar event.", "example" : null }, "webConferenceMeetingId" : { "type" : "string", "description" : "The unique identifier for the web conference meeting.", "example" : null }, "webConferenceUrl" : { "type" : "string", "description" : "The URL for accessing the meeting's web conference.", "example" : null } }, "example" : null }, "ExternalMeetingsLinkSettings" : { "required" : [ "availability", "durations", "formFields", "legalConsentEnabled", "meetingBufferTime", "ownerPrioritized", "startTimeIncrementMinutes", "weeksToAdvertise" ], "type" : "object", "properties" : { "availability" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ExternalClosedRange" }, "description" : "An array containing the closed range availability for a meeting link. Closed range times are provided as minute offsets from midnight (e.g., 540 corresponds to 9am).", "example" : null }, "customAvailabilityEndDate" : { "type" : "integer", "description" : "The end date for a meeting link's custom availability window, represented as Unix time in milliseconds.", "format" : "int64", "example" : null }, "customAvailabilityStartDate" : { "type" : "integer", "description" : "The start date for a meeting link's custom availability window, represented as Unix time in milliseconds.", "format" : "int64", "example" : null }, "displayInfo" : { "$ref" : "#/components/schemas/ExternalLinkDisplayInfo" }, "durations" : { "type" : "array", "example" : null, "items" : { "type" : "integer", "format" : "int64", "example" : null } }, "formFields" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalLinkFormField" } }, "guestSettings" : { "$ref" : "#/components/schemas/ExternalGuestSettings" }, "language" : { "type" : "string", "description" : "The language setting used for the meeting link.", "example" : null }, "legalConsentEnabled" : { "type" : "boolean", "description" : "Whether the legal consent checkbox is displayed during meeting booking.", "example" : null }, "legalConsentOptions" : { "$ref" : "#/components/schemas/ExternalLegalConsentOptions" }, "locale" : { "type" : "string", "description" : "The locale setting used for formatting dates and times in the meeting link.", "example" : null }, "location" : { "type" : "string", "description" : "The physical or virtual location where the meeting will take place.", "example" : null }, "meetingBufferTime" : { "type" : "integer", "description" : "The minimum buffer time in milliseconds between consecutive meetings.", "format" : "int64", "example" : null }, "ownerPrioritized" : { "type" : "boolean", "description" : "Indicates whether the meeting owner is prioritized during booking. Only applies to link types of ROUND_ROBIN.", "example" : null }, "redirectUrl" : { "type" : "string", "description" : "The URL to redirect to after a meeting is booked.", "example" : null }, "startTimeIncrementMinutes" : { "type" : "string", "description" : "The increment for available start times of meetings, spelt out as a word (e.g. 15 minute increment corresponds to `FIFTEEN`). `MEETING_DURATION` is also a valid value.", "example" : null, "enum" : [ "FIFTEEN", "FIVE", "FORTY_FIVE", "MEETING_DURATION", "NINETY", "ONE_HUNDRED_TWENTY", "SIXTY", "TEN", "THIRTY", "TWENTY" ] }, "weeksToAdvertise" : { "type" : "integer", "description" : "Legacy property that indicates the number of weeks in advance that availability is advertised. May be outdated or superseded by other properties.", "format" : "int32", "example" : null }, "welcomeScreenInfo" : { "$ref" : "#/components/schemas/ExternalMeetingsWelcomeScreenInfo" } }, "example" : null }, "ExternalMeetingsLinkUpdateRequest" : { "type" : "object", "properties" : { "paymentLinkId" : { "type" : "string", "example" : null } }, "example" : null }, "ExternalMeetingsUser" : { "required" : [ "calendarProvider", "id", "isSalesStarter", "userId", "userProfile" ], "type" : "object", "properties" : { "calendarProvider" : { "type" : "string", "description" : "The calendar provider associated with the user. Accepted values are: GOOGLE, OFFICE365, EXCHANGE, UNKNOWN.", "example" : null, "enum" : [ "EXCHANGE", "GOOGLE", "OFFICE365", "UNKNOWN" ] }, "id" : { "type" : "string", "description" : "The ID for the meetings user. This value is different than the userId.", "example" : null }, "isSalesStarter" : { "type" : "boolean", "description" : "Whether the user has a sales starter seat.", "example" : null }, "userId" : { "type" : "string", "description" : "The ID of the user.", "example" : null }, "userProfile" : { "$ref" : "#/components/schemas/ExternalUserProfile" } }, "example" : null }, "ExternalMeetingsWelcomeScreenInfo" : { "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A brief description displayed the welcome screen below the title.", "example" : null }, "logoUrl" : { "type" : "string", "description" : "The URL of the logo image to be displayed on the welcome screen, only used if `useCompanyLogo` is false.", "example" : null }, "showWelcomeScreen" : { "type" : "boolean", "description" : "Deprecated property. Value can be ignored but will always be false.", "example" : null }, "title" : { "type" : "string", "description" : "The main heading displayed on the welcome screen.", "example" : null }, "useCompanyLogo" : { "type" : "boolean", "description" : "Whether the company's logo should be displayed on the welcome screen.", "example" : null } }, "example" : null }, "ExternalOption" : { "required" : [ "description", "displayOrder", "doubleData", "hidden", "label", "readOnly", "value" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A brief description of the option.", "example" : null }, "displayOrder" : { "type" : "integer", "description" : "The order in which the option should be displayed.", "format" : "int32", "example" : null }, "doubleData" : { "type" : "number", "description" : "Deprecated property. Will always be 0.", "example" : null }, "hidden" : { "type" : "boolean", "description" : "Whether the option should be hidden from the user.", "example" : null }, "label" : { "type" : "string", "description" : "The text label for the option.", "example" : null }, "readOnly" : { "type" : "boolean", "description" : "Whether the option is read-only.", "example" : null }, "value" : { "type" : "string", "description" : "The value associated with the option.", "example" : null } }, "example" : null }, "ExternalReminder" : { "required" : [ "numberOfTimeUnits", "timeUnit" ], "type" : "object", "properties" : { "numberOfTimeUnits" : { "type" : "integer", "description" : "The number of timeUnits prior to the meeting start when the reminder will be sent.", "format" : "int32", "example" : null }, "timeUnit" : { "type" : "string", "description" : "Accepted values are: WEEKS, DAYS, HOURS, MINUTES.", "example" : null, "enum" : [ "DAYS", "HOURS", "MINUTES", "WEEKS" ] } }, "example" : null }, "ExternalTimeRange" : { "required" : [ "end", "start" ], "type" : "object", "properties" : { "end" : { "type" : "integer", "description" : "The end time of the time range, represented as Unix time in milliseconds.", "format" : "int64", "example" : null }, "start" : { "type" : "integer", "description" : "The start time of the time range, represented as Unix time in milliseconds.", "format" : "int64", "example" : null } }, "example" : null }, "ExternalUserBusyTimes" : { "required" : [ "busyTimes", "isOffline", "meetingsUser" ], "type" : "object", "properties" : { "busyTimes" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ExternalTimeRange" } }, "isOffline" : { "type" : "boolean", "description" : "Whether the user is offline.", "example" : null }, "meetingsUser" : { "$ref" : "#/components/schemas/ExternalMeetingsUser" } }, "example" : null }, "ExternalUserProfile" : { "required" : [ "email" ], "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "The email address of the user.", "example" : null }, "firstName" : { "type" : "string", "description" : "The first name of the user.", "example" : null }, "fullName" : { "type" : "string", "description" : "The full name of the user.", "example" : null }, "lastName" : { "type" : "string", "description" : "The last name of the user.", "example" : null } }, "example" : null }, "ExternalValidatedFormField" : { "required" : [ "isCustom", "label", "name", "value" ], "type" : "object", "properties" : { "fieldType" : { "type" : "string", "description" : "The specific input type of the form field. Corresponds to property types (e.g., `select`, `radio`, `date`, etc).", "example" : null }, "isCustom" : { "type" : "boolean", "description" : "Whether the form field is a custom field.", "example" : null }, "label" : { "type" : "string", "description" : "The text label associated with the form field.", "example" : null }, "name" : { "type" : "string", "description" : "The name identifier for the form field, includes underscores in place of spaces (e.g., the label `my form` is converted to `my_form`).", "example" : null }, "translatedLabel" : { "type" : "string", "description" : "The translated text label for the form field.", "example" : null }, "value" : { "type" : "string", "description" : "The value associated with the form field.", "example" : null }, "valueLabel" : { "type" : "string", "description" : "The text label associated to a form field selection or option.", "example" : null } }, "example" : null }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "A paging cursor token for retrieving subsequent pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the next page results.", "example" : null } }, "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response", "example" : null }, "Paging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" }, "prev" : { "$ref" : "#/components/schemas/PreviousPage" } }, "description" : "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.", "example" : null }, "PreviousPage" : { "required" : [ "before" ], "type" : "object", "properties" : { "before" : { "type" : "string", "description" : "A paging cursor token for retrieving previous pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the previous pages' results.", "example" : null } }, "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response", "example" : null }, "PublicObjectId" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for an object.", "example" : null } }, "description" : "Contains the Id of a Public Object", "example" : null } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "example" : null } } } }, "securitySchemes" : { "developer_hapikey" : { "type" : "apiKey", "name" : "hapikey", "in" : "query" }, "oauth2" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "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" : "", "scheduler.meetings.meeting-link.read" : "", "tickets.highly_sensitive.v2" : "", "tickets.sensitive.v2" : "" } } } }, "private_apps" : { "type" : "apiKey", "name" : "private-app", "in" : "header" }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }