POST Appointment

POST https://webhook.example.com

application/json

Body Required

id string Required
correlationId string Required
webhookConfigurationId string Required
version string Required
entity Required

Value is Appointment.
data object Required
Hide data attributes Show data attributes object
- eventType Required
  
  Values are ACCEPT, REASSIGN, CANCEL, COMPLETE, CREATE, RESCHEDULE, REQUEST_ALTERNATIVE_DATE, CREATE_REQUEST, RESCHEDULE_REQUEST, REOPEN, or GENERIC_UPDATE.
- message string | null Required Deprecated
- appointment object Required
  
  One of:
  Appointment object Incoming request object Outgoing request object
  
  Hide attributes Show attributes
  
  id string Required
  
  subject object Required
  
  Additional properties are NOT allowed.
  
  Hide subject attributes Show subject attributes object
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  enabledForCustomerUse boolean Required
  
  enabledForInternalUse boolean Required
  
  order integer Required
  
  Minimum value is 0.
  
  cancellationByAgentFormId string | null Required
  
  cancellationByCustomerFormId string | null Required
  
  completionByAgentFormId string | null Required
  
  questionnaireFormId string | null Required
  
  subjectGroup object Required
  
  Additional properties are NOT allowed.
  
  Hide subjectGroup attributes Show subjectGroup attributes object
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  order integer Required
  
  Minimum value is 0.
  
  color string | null
  
  Maximum length is 7.
  
  image string | null
  
  Maximum length is 65535.
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  instructions array[object] Required
  
  Hide instructions attributes Show instructions attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  office object Required
  
  Additional properties are NOT allowed.
  
  Hide office attributes Show office attributes object
  
  id string Required
  
  active boolean Required
  
  email string | null Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  phoneNumber string | null Required
  
  timeZone string Required
  
  usesIndependentAgents boolean Required
  
  virtual boolean Required
  
  location object Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  directions array[object] Required
  
  Hide directions attributes Show directions attributes object
  
  value string Required
  
  language string Required
  
  parkingInfo array[object] Required
  
  Hide parkingInfo attributes Show parkingInfo attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  participants array[object] Required
  
  One of:
  Employee object Customer object
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  type Required
  
  Values are EMPLOYEE or CUSTOMER.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  cancelUrl string Required
  
  editUrl string Required
  
  inviteUrl string Required
  
  office365CalendarUrl string Required
  
  googleCalendarUrl string Required
  
  icalUrl string Required
  
  createdAt string(date-time) Required
  
  employee object Required
  
  Additional properties are NOT allowed.
  
  Hide employee attributes Show employee attributes object
  
  id string Required
  
  communicationEmail string | null Required
  
  Maximum length is 320.
  
  email string Required
  
  Maximum length is 320.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  firstName string Required
  
  language string Required
  
  Maximum length is 2.
  
  lastName string Required
  
  onlinePlanning boolean Required
  
  phoneNumber string | null Required
  
  profilePictureUrl string | null Required
  
  staticVideoUrl string | null Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  function array[object] Required
  
  Hide function attributes Show function attributes object
  
  value string Required
  
  language string Required
  
  availableRoles array[string] Required
  
  Values are ADMIN, AGENT, CENTRAL_PLANNER, or OFFICE_MANAGER.
  
  status Required
  
  Values are ACTIVE, SUSPENDED, or PENDING.
  
  timeZone string Required
  
  userId string | null Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  type Required
  
  Values are EMPLOYEE or CUSTOMER.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  cancelUrl string Required
  
  editUrl string Required
  
  inviteUrl string Required
  
  office365CalendarUrl string Required
  
  googleCalendarUrl string Required
  
  icalUrl string Required
  
  createdAt string(date-time) Required
  
  customer object Required
  
  Additional properties are NOT allowed.
  
  Hide customer attributes Show customer attributes object
  
  id integer Required
  
  Minimum value is 0.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  customerNumber string | null Required
  
  email string | null Required
  
  Maximum length is 320.
  
  firstName string | null Required
  
  lastName string | null Required
  
  existing boolean Required
  
  company string | null Required
  
  language string Required
  
  Maximum length is 2.
  
  notes string | null Required
  
  phoneNumber string | null Required
  
  timeZone string Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  answers array[object] Required
  
  Hide answers attributes Show answers attributes object
  
  id string Required
  
  form object Required
  
  Additional properties are NOT allowed.
  
  Hide form attribute Show form attribute object
  
  id string Required
  
  question object Required
  
  Additional properties are NOT allowed.
  
  Hide question attributes Show question attributes object
  
  id string Required
  
  externalId string | null
  
  order integer Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  label array[object] Required
  
  Hide label attributes Show label attributes object
  
  value string Required
  
  language string Required
  
  answerType Required
  
  Values are SUBJECT_QUESTIONNAIRE, APPOINTMENT_CANCELLATION, APPOINTMENT_COMPLETION, or QUALIFICATION.
  
  value string | null
  
  selectedAnswerOptions array[object] | null
  
  Hide selectedAnswerOptions attributes Show selectedAnswerOptions attributes object
  
  id string Required
  
  externalId string | null
  
  value string | null
  
  files array[object] | null
  
  Hide files attribute Show files attribute object
  
  id string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  callbackRequest Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  listing object | null Required
  
  Additional properties are NOT allowed.
  
  Hide listing attributes Show listing attributes object | null
  
  id string Required
  
  active boolean Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  timeZone string Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  tags array[string] Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  leadSegment object | null Required
  
  Additional properties are NOT allowed.
  
  Hide leadSegment attributes Show leadSegment attributes object | null
  
  id integer Required
  
  Minimum value is 0.
  
  active boolean Required
  
  code string Required
  
  Maximum length is 255.
  
  description string | null Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  meetingType Required
  
  Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  hybrid boolean Required
  
  trailingBufferTime integer Required
  
  internalNotes string | null Required
  
  meetingRoom object | null Required
  
  Additional properties are NOT allowed.
  
  Hide meetingRoom attributes Show meetingRoom attributes object | null
  
  id string Required
  
  email string Required
  
  externalId string Required
  
  name string Required
  
  provider string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  messageForCustomer string | null Required
  
  metadata object | null Required
  
  userCommunication object Required
  
  Additional properties are NOT allowed.
  
  Hide userCommunication attributes Show userCommunication attributes object
  
  notifications string Required
  
  notificationsOverrideCurrentAction string Required
  
  reminders string Required
  
  createdAt string(date-time) Required
  
  createdById string | null
  
  createdByType Required
  
  Values are CUSTOMER, EMPLOYEE, or OTHER.
  
  createdFrom Required
  
  Values are PLUGIN, BACKOFFICE_APP, PARTNER_BOOKING_APP, or OTHER.
  
  updatedAt string(date-time) Required
  
  updatedById string | null Required
  
  updatedByType Required
  
  Values are CUSTOMER, EMPLOYEE, or OTHER.
  
  updatedFrom Required
  
  Values are PLUGIN, BACKOFFICE_APP, PARTNER_BOOKING_APP, or OTHER.
  
  status Required
  
  Values are ACCEPTED, COMPLETED, NO_SHOW, or CANCELLED.
  
  start string(date-time) Required
  
  end string(date-time) Required
  
  Hide attributes Show attributes
  
  id string Required
  
  subject object Required
  
  Additional properties are NOT allowed.
  
  Hide subject attributes Show subject attributes object
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  enabledForCustomerUse boolean Required
  
  enabledForInternalUse boolean Required
  
  order integer Required
  
  Minimum value is 0.
  
  cancellationByAgentFormId string | null Required
  
  cancellationByCustomerFormId string | null Required
  
  completionByAgentFormId string | null Required
  
  questionnaireFormId string | null Required
  
  subjectGroup object Required
  
  Additional properties are NOT allowed.
  
  Hide subjectGroup attributes Show subjectGroup attributes object
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  order integer Required
  
  Minimum value is 0.
  
  color string | null
  
  Maximum length is 7.
  
  image string | null
  
  Maximum length is 65535.
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  instructions array[object] Required
  
  Hide instructions attributes Show instructions attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  office object Required
  
  Additional properties are NOT allowed.
  
  Hide office attributes Show office attributes object
  
  id string Required
  
  active boolean Required
  
  email string | null Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  phoneNumber string | null Required
  
  timeZone string Required
  
  usesIndependentAgents boolean Required
  
  virtual boolean Required
  
  location object Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  directions array[object] Required
  
  Hide directions attributes Show directions attributes object
  
  value string Required
  
  language string Required
  
  parkingInfo array[object] Required
  
  Hide parkingInfo attributes Show parkingInfo attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  participants array[object] Required
  
  One of:
  Employee object Customer object
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  type Required
  
  Values are EMPLOYEE or CUSTOMER.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  cancelUrl string Required
  
  editUrl string Required
  
  inviteUrl string Required
  
  office365CalendarUrl string Required
  
  googleCalendarUrl string Required
  
  icalUrl string Required
  
  createdAt string(date-time) Required
  
  employee object Required
  
  Additional properties are NOT allowed.
  
  Hide employee attributes Show employee attributes object
  
  id string Required
  
  communicationEmail string | null Required
  
  Maximum length is 320.
  
  email string Required
  
  Maximum length is 320.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  language string Required
  
  Maximum length is 2.
  
  lastName string | null Required
  
  onlinePlanning boolean Required
  
  phoneNumber string | null Required
  
  profilePictureUrl string | null Required
  
  staticVideoUrl string | null Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  function array[object] Required
  
  Hide function attributes Show function attributes object
  
  value string Required
  
  language string Required
  
  availableRoles array[string] Required
  
  Values are ADMIN, AGENT, CENTRAL_PLANNER, or OFFICE_MANAGER.
  
  status Required
  
  Values are ACTIVE, SUSPENDED, or PENDING.
  
  timeZone string Required
  
  userId string | null Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  type Required
  
  Values are EMPLOYEE or CUSTOMER.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  cancelUrl string Required
  
  editUrl string Required
  
  inviteUrl string Required
  
  office365CalendarUrl string Required
  
  googleCalendarUrl string Required
  
  icalUrl string Required
  
  createdAt string(date-time) Required
  
  customer object Required
  
  Additional properties are NOT allowed.
  
  Hide customer attributes Show customer attributes object
  
  id integer Required
  
  Minimum value is 0.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  customerNumber string | null Required
  
  email string | null Required
  
  Maximum length is 320.
  
  firstName string | null Required
  
  lastName string | null Required
  
  existing boolean Required
  
  company string | null Required
  
  language string Required
  
  Maximum length is 2.
  
  notes string | null Required
  
  phoneNumber string | null Required
  
  timeZone string Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  answers array[object] Required
  
  Hide answers attributes Show answers attributes object
  
  id string Required
  
  form object Required
  
  Additional properties are NOT allowed.
  
  Hide form attribute Show form attribute object
  
  id string Required
  
  question object Required
  
  Additional properties are NOT allowed.
  
  Hide question attributes Show question attributes object
  
  id string Required
  
  externalId string | null
  
  order integer Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  label array[object] Required
  
  Hide label attributes Show label attributes object
  
  value string Required
  
  language string Required
  
  answerType Required
  
  Values are SUBJECT_QUESTIONNAIRE, APPOINTMENT_CANCELLATION, APPOINTMENT_COMPLETION, or QUALIFICATION.
  
  value string | null
  
  selectedAnswerOptions array[object] | null
  
  Hide selectedAnswerOptions attributes Show selectedAnswerOptions attributes object
  
  id string Required
  
  externalId string | null
  
  value string | null
  
  files array[object] | null
  
  Hide files attribute Show files attribute object
  
  id string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  callbackRequest Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  listing object | null Required
  
  Additional properties are NOT allowed.
  
  Hide listing attributes Show listing attributes object | null
  
  id string Required
  
  active boolean Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  timeZone string Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  tags array[string] Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  leadSegment object | null Required
  
  Additional properties are NOT allowed.
  
  Hide leadSegment attributes Show leadSegment attributes object | null
  
  id integer Required
  
  Minimum value is 0.
  
  active boolean Required
  
  code string Required
  
  Maximum length is 255.
  
  description string | null Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  meetingType Required
  
  Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  hybrid boolean Required
  
  trailingBufferTime integer Required
  
  internalNotes string | null Required
  
  meetingRoom object | null Required
  
  Additional properties are NOT allowed.
  
  Hide meetingRoom attributes Show meetingRoom attributes object | null
  
  id string Required
  
  email string Required
  
  externalId string Required
  
  name string Required
  
  provider string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  messageForCustomer string | null Required
  
  metadata object | null Required
  
  userCommunication object Required
  
  Additional properties are NOT allowed.
  
  Hide userCommunication attributes Show userCommunication attributes object
  
  notifications string Required
  
  notificationsOverrideCurrentAction string Required
  
  reminders string Required
  
  createdAt string(date-time) Required
  
  createdById string | null
  
  createdByType Required
  
  Values are CUSTOMER, EMPLOYEE, or OTHER.
  
  createdFrom Required
  
  Values are PLUGIN, BACKOFFICE_APP, PARTNER_BOOKING_APP, or OTHER.
  
  updatedAt string(date-time) Required
  
  updatedById string | null Required
  
  updatedByType Required
  
  Values are CUSTOMER, EMPLOYEE, or OTHER.
  
  updatedFrom Required
  
  Values are PLUGIN, BACKOFFICE_APP, PARTNER_BOOKING_APP, or OTHER.
  
  status Required
  
  Value is INCOMING_REQUEST.
  
  start string(date-time) Required
  
  end string(date-time) Required
  
  Hide attributes Show attributes
  
  id string Required
  
  subject object Required
  
  Additional properties are NOT allowed.
  
  Hide subject attributes Show subject attributes object
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  enabledForCustomerUse boolean Required
  
  enabledForInternalUse boolean Required
  
  order integer Required
  
  Minimum value is 0.
  
  cancellationByAgentFormId string | null Required
  
  cancellationByCustomerFormId string | null Required
  
  completionByAgentFormId string | null Required
  
  questionnaireFormId string | null Required
  
  subjectGroup object Required
  
  Additional properties are NOT allowed.
  
  Hide subjectGroup attributes Show subjectGroup attributes object
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  order integer Required
  
  Minimum value is 0.
  
  color string | null
  
  Maximum length is 7.
  
  image string | null
  
  Maximum length is 65535.
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  instructions array[object] Required
  
  Hide instructions attributes Show instructions attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  office object Required
  
  Additional properties are NOT allowed.
  
  Hide office attributes Show office attributes object
  
  id string Required
  
  active boolean Required
  
  email string | null Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  phoneNumber string | null Required
  
  timeZone string Required
  
  usesIndependentAgents boolean Required
  
  virtual boolean Required
  
  location object Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  directions array[object] Required
  
  Hide directions attributes Show directions attributes object
  
  value string Required
  
  language string Required
  
  parkingInfo array[object] Required
  
  Hide parkingInfo attributes Show parkingInfo attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  participants array[object] Required
  
  One of:
  Employee object Customer object
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  type Required
  
  Values are EMPLOYEE or CUSTOMER.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  cancelUrl string Required
  
  editUrl string Required
  
  inviteUrl string Required
  
  office365CalendarUrl string Required
  
  googleCalendarUrl string Required
  
  icalUrl string Required
  
  createdAt string(date-time) Required
  
  employee object Required
  
  Additional properties are NOT allowed.
  
  Hide employee attributes Show employee attributes object
  
  id string Required
  
  communicationEmail string | null Required
  
  Maximum length is 320.
  
  email string Required
  
  Maximum length is 320.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  firstName string Required
  
  language string Required
  
  Maximum length is 2.
  
  lastName string | null Required
  
  onlinePlanning boolean Required
  
  phoneNumber string | null Required
  
  profilePictureUrl string | null Required
  
  staticVideoUrl string | null Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  function array[object] Required
  
  Hide function attributes Show function attributes object
  
  value string Required
  
  language string Required
  
  availableRoles array[string] Required
  
  Values are ADMIN, AGENT, CENTRAL_PLANNER, or OFFICE_MANAGER.
  
  status Required
  
  Values are ACTIVE, SUSPENDED, or PENDING.
  
  timeZone string Required
  
  userId string | null Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  type Required
  
  Values are EMPLOYEE or CUSTOMER.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  cancelUrl string Required
  
  editUrl string Required
  
  inviteUrl string Required
  
  office365CalendarUrl string Required
  
  googleCalendarUrl string Required
  
  icalUrl string Required
  
  createdAt string(date-time) Required
  
  customer object Required
  
  Additional properties are NOT allowed.
  
  Hide customer attributes Show customer attributes object
  
  id integer Required
  
  Minimum value is 0.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  customerNumber string | null Required
  
  email string | null Required
  
  Maximum length is 320.
  
  firstName string | null Required
  
  lastName string | null Required
  
  existing boolean Required
  
  company string | null Required
  
  language string Required
  
  Maximum length is 2.
  
  notes string | null Required
  
  phoneNumber string | null Required
  
  timeZone string Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  answers array[object] Required
  
  Hide answers attributes Show answers attributes object
  
  id string Required
  
  form object Required
  
  Additional properties are NOT allowed.
  
  Hide form attribute Show form attribute object
  
  id string Required
  
  question object Required
  
  Additional properties are NOT allowed.
  
  Hide question attributes Show question attributes object
  
  id string Required
  
  externalId string | null
  
  order integer Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  label array[object] Required
  
  Hide label attributes Show label attributes object
  
  value string Required
  
  language string Required
  
  answerType Required
  
  Values are SUBJECT_QUESTIONNAIRE, APPOINTMENT_CANCELLATION, APPOINTMENT_COMPLETION, or QUALIFICATION.
  
  value string | null
  
  selectedAnswerOptions array[object] | null
  
  Hide selectedAnswerOptions attributes Show selectedAnswerOptions attributes object
  
  id string Required
  
  externalId string | null
  
  value string | null
  
  files array[object] | null
  
  Hide files attribute Show files attribute object
  
  id string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  callbackRequest Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  listing object | null Required
  
  Additional properties are NOT allowed.
  
  Hide listing attributes Show listing attributes object | null
  
  id string Required
  
  active boolean Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  timeZone string Required
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  tags array[string] Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  name array[object] Required
  
  Hide name attributes Show name attributes object
  
  value string Required
  
  language string Required
  
  description array[object] Required
  
  Hide description attributes Show description attributes object
  
  value string Required
  
  language string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  leadSegment object | null Required
  
  Additional properties are NOT allowed.
  
  Hide leadSegment attributes Show leadSegment attributes object | null
  
  id integer Required
  
  Minimum value is 0.
  
  active boolean Required
  
  code string Required
  
  Maximum length is 255.
  
  description string | null Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  meetingType Required
  
  Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
  
  externalId string | null Required
  
  Maximum length is 255.
  
  hybrid boolean Required
  
  trailingBufferTime integer Required
  
  internalNotes string | null Required
  
  meetingRoom object | null Required
  
  Additional properties are NOT allowed.
  
  Hide meetingRoom attributes Show meetingRoom attributes object | null
  
  id string Required
  
  email string Required
  
  externalId string Required
  
  name string Required
  
  provider string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  deletedAt string | null Required
  
  messageForCustomer string | null Required
  
  metadata object | null Required
  
  userCommunication object Required
  
  Additional properties are NOT allowed.
  
  Hide userCommunication attributes Show userCommunication attributes object
  
  notifications string Required
  
  notificationsOverrideCurrentAction string Required
  
  reminders string Required
  
  createdAt string(date-time) Required
  
  createdById string | null
  
  createdByType Required
  
  Values are CUSTOMER, EMPLOYEE, or OTHER.
  
  createdFrom Required
  
  Values are PLUGIN, BACKOFFICE_APP, PARTNER_BOOKING_APP, or OTHER.
  
  updatedAt string(date-time) Required
  
  updatedById string | null Required
  
  updatedByType Required
  
  Values are CUSTOMER, EMPLOYEE, or OTHER.
  
  updatedFrom Required
  
  Values are PLUGIN, BACKOFFICE_APP, PARTNER_BOOKING_APP, or OTHER.
  
  status Required
  
  Values are OUTGOING_INVITE or ALTERNATIVE_DATE_REQUESTED.
  
  start null Required
  
  end null Required
- previousAppointment object | null Required
  
  One of:
  Appointment object | null Incoming request object | null Outgoing request object | null
  
  Hide attributes Show attributes
  
  subject object Required
  
  Additional properties are NOT allowed.
  
  Hide subject attribute Show subject attribute object
  
  id string Required
  
  office object Required
  
  Additional properties are NOT allowed.
  
  Hide office attribute Show office attribute object
  
  id string Required
  
  participants array[object] Required
  
  One of:
  Employee object Customer object
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  employee object Required
  
  Additional properties are NOT allowed.
  
  Hide employee attribute Show employee attribute object
  
  id string Required
  
  type Required
  
  Value is EMPLOYEE.
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  customer object Required
  
  Additional properties are NOT allowed.
  
  Hide customer attribute Show customer attribute object
  
  id string Required
  
  type Required
  
  Value is CUSTOMER.
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  listing object | null Required
  
  Additional properties are NOT allowed.
  
  Hide listing attribute Show listing attribute object | null
  
  id string Required
  
  leadSegment object | null Required
  
  Additional properties are NOT allowed.
  
  Hide leadSegment attribute Show leadSegment attribute object | null
  
  id string Required
  
  meetingRoom object | null
  
  Additional properties are NOT allowed.
  
  Hide meetingRoom attribute Show meetingRoom attribute object | null
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  status Required
  
  Values are ACCEPTED, COMPLETED, NO_SHOW, or CANCELLED.
  
  start string(date-time) Required
  
  end string(date-time) Required
  
  Hide attributes Show attributes
  
  subject object Required
  
  Additional properties are NOT allowed.
  
  Hide subject attribute Show subject attribute object
  
  id string Required
  
  office object Required
  
  Additional properties are NOT allowed.
  
  Hide office attribute Show office attribute object
  
  id string Required
  
  participants array[object] Required
  
  One of:
  Employee object Customer object
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  employee object Required
  
  Additional properties are NOT allowed.
  
  Hide employee attribute Show employee attribute object
  
  id string Required
  
  type Required
  
  Value is EMPLOYEE.
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  customer object Required
  
  Additional properties are NOT allowed.
  
  Hide customer attribute Show customer attribute object
  
  id string Required
  
  type Required
  
  Value is CUSTOMER.
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  listing object | null Required
  
  Additional properties are NOT allowed.
  
  Hide listing attribute Show listing attribute object | null
  
  id string Required
  
  leadSegment object | null Required
  
  Additional properties are NOT allowed.
  
  Hide leadSegment attribute Show leadSegment attribute object | null
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  status Required
  
  Value is INCOMING_REQUEST.
  
  start string(date-time) Required
  
  end string(date-time) Required
  
  Hide attributes Show attributes
  
  subject object Required
  
  Additional properties are NOT allowed.
  
  Hide subject attribute Show subject attribute object
  
  id string Required
  
  office object Required
  
  Additional properties are NOT allowed.
  
  Hide office attribute Show office attribute object
  
  id string Required
  
  participants array[object] Required
  
  One of:
  Employee object Customer object
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  employee object Required
  
  Additional properties are NOT allowed.
  
  Hide employee attribute Show employee attribute object
  
  id string Required
  
  type Required
  
  Value is EMPLOYEE.
  
  Hide attributes Show attributes
  
  role Required
  
  Values are PRIMARY or SECONDARY.
  
  token string Required
  
  videoUrl string | null Required
  
  Maximum length is 2000.
  
  videoTestUrl string | null Required
  
  Maximum length is 2000.
  
  customer object Required
  
  Additional properties are NOT allowed.
  
  Hide customer attribute Show customer attribute object
  
  id string Required
  
  type Required
  
  Value is CUSTOMER.
  
  location object | null Required
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object | null
  
  postalCode string | null Required
  
  countryCode string Required
  
  Minimum length is 2, maximum length is 2.
  
  geolocation object Required
  
  Additional properties are NOT allowed.
  
  Hide geolocation attributes Show geolocation attributes object
  
  latitude number Required
  
  longitude number Required
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attributes Show translations attributes object
  
  city array[object] Required
  
  Hide city attributes Show city attributes object
  
  value string Required
  
  language string Required
  
  street1 array[object] Required
  
  Hide street1 attributes Show street1 attributes object
  
  value string Required
  
  language string Required
  
  street2 array[object] Required
  
  Hide street2 attributes Show street2 attributes object
  
  value string Required
  
  language string Required
  
  state array[object] Required
  
  Hide state attributes Show state attributes object
  
  value string Required
  
  language string Required
  
  listing object | null Required
  
  Additional properties are NOT allowed.
  
  Hide listing attribute Show listing attribute object | null
  
  id string Required
  
  leadSegment object | null Required
  
  Additional properties are NOT allowed.
  
  Hide leadSegment attribute Show leadSegment attribute object | null
  
  id string Required
  
  externalId string | null Required
  
  Maximum length is 255.
  
  status Required
  
  Values are OUTGOING_INVITE or ALTERNATIVE_DATE_REQUESTED.
  
  start null Required
  
  end null Required

Responses

200

Your server returns this code if it succesfully processed the event
201

Your server returns this code if it succesfully processed the event
202

Your server returns this code if it succesfully processed the event
204

Your server returns this code if it succesfully processed the event

POST Appointment

Request examples

{
  "id": "string",
  "correlationId": "string",
  "webhookConfigurationId": "string",
  "version": "string",
  "entity": "Appointment",
  "data": {
    "eventType": "ACCEPT",
    "message": "string",
    "appointment": {
      "id": "string",
      "subject": {
        "id": "string",
        "externalId": "string",
        "enabledForCustomerUse": true,
        "enabledForInternalUse": true,
        "order": 42,
        "cancellationByAgentFormId": "string",
        "cancellationByCustomerFormId": "string",
        "completionByAgentFormId": "string",
        "questionnaireFormId": "string",
        "subjectGroup": {
          "id": "string",
          "externalId": "string",
          "order": 42,
          "color": "string",
          "image": "string",
          "translations": {
            "name": [
              {
                "value": "string",
                "language": "string"
              }
            ]
          },
          "createdAt": "2025-05-04T09:42:00Z",
          "updatedAt": "2025-05-04T09:42:00Z"
        },
        "translations": {
          "name": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "description": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "instructions": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        },
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z"
      },
      "office": {
        "id": "string",
        "active": true,
        "email": "string",
        "externalId": "string",
        "phoneNumber": "string",
        "timeZone": "string",
        "usesIndependentAgents": true,
        "virtual": true,
        "location": {
          "postalCode": "string",
          "countryCode": "string",
          "geolocation": {
            "latitude": 42.0,
            "longitude": 42.0
          },
          "translations": {
            "city": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "street1": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "street2": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "state": [
              {
                "value": "string",
                "language": "string"
              }
            ]
          }
        },
        "translations": {
          "name": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "description": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "directions": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "parkingInfo": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        },
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z"
      },
      "participants": [
        {
          "role": "PRIMARY",
          "type": "EMPLOYEE",
          "token": "string",
          "videoUrl": "string",
          "videoTestUrl": "string",
          "cancelUrl": "string",
          "editUrl": "string",
          "inviteUrl": "string",
          "office365CalendarUrl": "string",
          "googleCalendarUrl": "string",
          "icalUrl": "string",
          "createdAt": "2025-05-04T09:42:00Z",
          "employee": {
            "id": "string",
            "communicationEmail": "string",
            "email": "string",
            "externalId": "string",
            "firstName": "string",
            "language": "string",
            "lastName": "string",
            "onlinePlanning": true,
            "phoneNumber": "string",
            "profilePictureUrl": "string",
            "staticVideoUrl": "string",
            "translations": {
              "function": [
                {
                  "value": "string",
                  "language": "string"
                }
              ]
            },
            "availableRoles": [
              "ADMIN"
            ],
            "status": "ACTIVE",
            "timeZone": "string",
            "userId": "string",
            "createdAt": "2025-05-04T09:42:00Z",
            "updatedAt": "2025-05-04T09:42:00Z"
          }
        }
      ],
      "answers": [
        {
          "id": "string",
          "form": {
            "id": "string"
          },
          "question": {
            "id": "string",
            "externalId": "string",
            "order": 42,
            "translations": {
              "label": [
                {
                  "value": "string",
                  "language": "string"
                }
              ]
            }
          },
          "answerType": "SUBJECT_QUESTIONNAIRE",
          "value": "string",
          "selectedAnswerOptions": [
            {
              "id": "string",
              "externalId": "string",
              "value": "string"
            }
          ],
          "files": [
            {
              "id": "string"
            }
          ],
          "createdAt": "2025-05-04T09:42:00Z",
          "updatedAt": "2025-05-04T09:42:00Z"
        }
      ],
      "location": {
        "postalCode": "string",
        "countryCode": "string",
        "geolocation": {
          "latitude": 42.0,
          "longitude": 42.0
        },
        "translations": {
          "city": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "street1": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "street2": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "state": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        }
      },
      "listing": {
        "id": "string",
        "active": true,
        "externalId": "string",
        "timeZone": "string",
        "location": {
          "postalCode": "string",
          "countryCode": "string",
          "geolocation": {
            "latitude": 42.0,
            "longitude": 42.0
          },
          "translations": {
            "city": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "street1": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "street2": [
              {
                "value": "string",
                "language": "string"
              }
            ],
            "state": [
              {
                "value": "string",
                "language": "string"
              }
            ]
          }
        },
        "tags": [
          "string"
        ],
        "translations": {
          "name": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "description": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        },
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z"
      },
      "leadSegment": {
        "id": 42,
        "active": true,
        "code": "string",
        "description": "string",
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z",
        "deletedAt": "string"
      },
      "meetingType": "OFFICE",
      "externalId": "string",
      "hybrid": true,
      "trailingBufferTime": 42,
      "internalNotes": "string",
      "meetingRoom": {
        "id": "string",
        "email": "string",
        "externalId": "string",
        "name": "string",
        "provider": "string",
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z",
        "deletedAt": "string"
      },
      "messageForCustomer": "string",
      "metadata": {},
      "userCommunication": {
        "notifications": "string",
        "notificationsOverrideCurrentAction": "string",
        "reminders": "string"
      },
      "createdAt": "2025-05-04T09:42:00Z",
      "createdById": "string",
      "createdByType": "CUSTOMER",
      "createdFrom": "PLUGIN",
      "updatedAt": "2025-05-04T09:42:00Z",
      "updatedById": "string",
      "updatedByType": "CUSTOMER",
      "updatedFrom": "PLUGIN",
      "status": "ACCEPTED",
      "start": "2025-05-04T09:42:00Z",
      "end": "2025-05-04T09:42:00Z"
    },
    "previousAppointment": {
      "subject": {
        "id": "string"
      },
      "office": {
        "id": "string"
      },
      "participants": [
        {
          "role": "PRIMARY",
          "token": "string",
          "videoUrl": "string",
          "videoTestUrl": "string",
          "employee": {
            "id": "string"
          },
          "type": "EMPLOYEE"
        }
      ],
      "location": {
        "postalCode": "string",
        "countryCode": "string",
        "geolocation": {
          "latitude": 42.0,
          "longitude": 42.0
        },
        "translations": {
          "city": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "street1": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "street2": [
            {
              "value": "string",
              "language": "string"
            }
          ],
          "state": [
            {
              "value": "string",
              "language": "string"
            }
          ]
        }
      },
      "listing": {
        "id": "string"
      },
      "leadSegment": {
        "id": "string"
      },
      "meetingRoom": {
        "id": "string"
      },
      "externalId": "string",
      "status": "ACCEPTED",
      "start": "2025-05-04T09:42:00Z",
      "end": "2025-05-04T09:42:00Z"
    }
  }
}

POST Appointment

Body Required

appointment object Required

previousAppointment object | null Required

Responses