Do not miss any Pexip Engage API changes, ever again

Subscribe to the Pexip Engage API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
10.10.2
10 structure changes including:
1 Addition
9 Modifications
Modified 9
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • description property Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • translations property Modified
      • description property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
POST /employees
  • Body
  • application/json content type Modified
    • translations property Modified
      • description property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • participants property Modified
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • participants property Modified
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • participants property Modified
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • participants property Modified
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Modified
Added 1
POST /appointments/{id}/_actions/update-details
10.8.3
32 structure changes including:
32 Modifications
Modified 32 Breaking
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /customers/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /employees/{employeeId}/availability-templates/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /fetch-configurations/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /forms/{formId}/questions/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /forms/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /lead-segments/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /listings/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /offices/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /subject-groups/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /subjects/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /appointments/{id}/_actions/complete
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /appointments/{id}/_actions/request-reschedule
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /contexts
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /customers
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{employeeId}/offices/{officeId}/expertise
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{id}/favorite-agents
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{id}/office-coverage-regions
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{id}/office-subject-coverage-regions
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /lead-segments/{id}/scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /listings/{id}/scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /offices/{id}/expertises
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /offices/{id}/scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /offices/{id}/subject-availability-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /offices/{id}/subject-scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /subjects/{id}/availability-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /subjects/{id}/scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
10.5.0
1 structure change including:
1 Modification
Modified 1
GET /data-export/conversion-analytics-sessions
  • Query
  • intent query parameter Added
10.4.0
3 structure changes including:
1 Breaking change
2 Additions
1 Removal
Removed 1 Breaking
GET /data-export/{resource}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
GET /data-export/appointments
GET /data-export/conversion-analytics-sessions
10.2.4
1 structure change including:
1 Addition
Added 1
POST PingWebhookwebhook
10.2.3
17 structure changes including:
1 Addition
16 Modifications
Modified 16
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData alternatives Modified
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
POST /subject-groups
  • Body
  • application/json content type Modified
    • translations property Modified
      • description property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
POST /appointments/{id}/_actions/update-meeting-type
  • Body
  • application/json content type Modified
    • updatedByType, updatedById properties Added
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • updatedByType, updatedById properties Added
POST /appointments/{id}/_actions/request-reschedule
  • Body
  • application/json content type Modified
    • updatedByType, updatedById properties Added
POST /appointments/{id}/_actions/reassign
  • Body
  • application/json content type Modified
    • updatedByType, updatedById properties Added
POST /appointments/{id}/_actions/complete
  • Body
  • application/json content type Modified
    • updatedByType, updatedById properties Added
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • updatedByType, updatedById properties Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • createdByType, createdById properties Added
POST /appointments
  • Body
  • application/json content type Modified
    • createdByType, createdById properties Added
PATCH /subject-groups/{id}
  • Body
  • application/json content type Modified
    • translations property Modified
      • description property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • updatedByType, updatedById properties Added
GET /subject-groups/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
GET /subject-groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • description property Added
Added 1
POST /appointments/{id}/_actions/update-location
9.12.0
18 structure changes including:
18 Modifications
Modified 18
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/update-meeting-type
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • answers property Modified
        • uuid property Added
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • answers property Modified
        • uuid property Added
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • answers property Modified
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • answers property Modified
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Modified
9.10.2
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answerOptions property Modified
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ValidatorTranslations, answerOptions properties Modified
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ValidatorTranslations, answerOptions properties Modified
POST /forms/{formId}/questions
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • translations property Modified
        • errorMessage property Modified
          • Property is now required
            Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • ValidatorTranslations, answerOptions properties Modified
9.9.2
28 structure changes including:
6 Additions
22 Modifications
Modified 22
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Modified
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • OfficeWebhook, participants properties Modified
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • OfficeWebhook, participants properties Modified
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • office, participants properties Modified
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • office, participants properties Modified
PUT /offices/{id}/subject-scheduling-settings
  • Body
  • application/json content type Modified
    • meetingRoomSelection property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRoomSelection property Added
POST /offices
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /listings
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
POST /employees/{id}/unavailability
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • answers, id properties Added
POST /employees
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
PATCH /offices/{id}
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
PATCH /listings/{id}
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /unavailability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Added
GET /offices/{id}/subject-scheduling-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRoomSelection property Added
GET /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /listings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
GET /listings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
GET /employees/{id}/unavailability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers, id properties Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
Added 6
PUT /employees/{employeeId}/offices/{officeId}/expertise
POST /employees/{id}/unavailability-event
POST /contexts
POST /appointments/{id}/_actions/update-meeting-type
GET /contexts/{id}
DELETE /employees/{employeeId}/unavailability-event/{id}
1 structure change including:
1 Addition
Added 1
GET /regions
4 structure changes including:
4 Modifications
Modified 4
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • object-1 property Modified
      • Property is no longer required
POST /appointments
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • Property is no longer required
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • Property is no longer required
POST /callback-requests
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • Property is no longer required
9.0.0
43 structure changes including:
7 Breaking changes
5 Additions
33 Modifications
5 Removals
Modified 33 Breaking
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • array-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
PATCH /forms/{id}
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
POST /appointments
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /callback-requests
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /employees
  • Body
  • application/json content type Modified
    • array-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
POST /employees/{id}/applied-templates/_actions/revert
  • Path went from /employees/{id}/applied-templates to /employees/{id}/applied-templates/_actions/revert (same operationId)
    Breaking
  • Verb went from DELETE to POST (same operationId)
    Breaking
POST /employees/{id}/unavailability/_actions/revert
  • Path went from /employees/{id}/unavailability to /employees/{id}/unavailability/_actions/revert (same operationId)
    Breaking
  • Verb went from DELETE to POST (same operationId)
    Breaking
POST /forms
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
PUT /employees/{id}/office-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
PUT /employees/{id}/office-subject-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
PUT /subjects/{id}/availability-settings
  • Body
  • application/json content type Modified
    • rank1offset, rank2offset properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • rank1offset, rank2offset properties Added
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /callback-requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
GET /employees/{employeeId}/external-calendar-events
  • Path went from /employees/{id}/external-calendar-events to /employees/{employeeId}/external-calendar-events (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • employeeId path parameter Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
GET /employees/{id}/office-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
GET /employees/{id}/office-subject-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
GET /forms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
  • Query
  • external-id query parameter Added
GET /forms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
GET /subjects/{id}/availability-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • rank1offset, rank2offset properties Added
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
PATCH /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
Removed 5 Breaking
GET /static-translation-overrides
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /static-translations/{language}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /static-translation-overrides
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Appointmentwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Pingwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
POST CommunicationWebhookwebhook
POST CallbackRequestUpdatewebhook
POST CallbackRequestCreatewebhook
POST AppointmentUpdatewebhook
POST AppointmentCreatewebhook
7.2.1
1 structure change including:
1 Modification
Modified 1
POST Appointmentwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
7.2.0
1 structure change including:
1 Modification
Modified 1
POST Appointmentwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
7.1.0
3 structure changes including:
1 Addition
2 Modifications
Modified 2
GET /callback-requests
  • Query
  • created-from-date, created-to-date query parameters Added
GET /timetable
  • Query
  • employee-languages query parameter Added
Added 1
GET /data-export/{resource}
6.2.0
11 structure changes including:
1 Breaking change
10 Modifications
1 Removal
Modified 10 Breaking
GET /appointments
  • Query
  • created-from-date, created-to-date query parameters Added
GET /employees/{id}/office-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
GET /employees/{id}/office-subject-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
GET /schedulable/employees
  • Query
  • location query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
  • order-by-distance-to query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
GET /schedulable/meeting-types
  • Query
  • location query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
  • order-by-distance-to query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
GET /schedulable/offices
  • Query
  • location query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
  • order-by-distance-to query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • number-1 property Added
GET /schedulable/subjects
  • Query
  • location query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
  • order-by-distance-to query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
GET /timetable
  • Query
  • location query parameter Modified
    • latitude, longitude query parameters Modified
      • Type went from number to string
        Breaking
PUT /employees/{id}/office-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
PUT /employees/{id}/office-subject-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
Removed 1 Breaking
GET /regions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
6.0.3
33 structure changes including:
12 Additions
21 Modifications
Modified 21 Breaking
GET /offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRooms property Added
GET /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRooms property Added
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • array-1 property Added
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • firstName, lastName properties Modified
      • Type went from string | null to string
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firstName, lastName properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to string
            Breaking
PATCH /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRooms property Added
POST /appointments
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • array-1 property Added
    • string-1, string-1, object-1 properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • string-1, string-1, object-1 properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • array-1 property Added
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/complete
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • array-1 property Added
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/reassign
  • Body
  • application/json content type Modified
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/request-reschedule
  • Body
  • application/json content type Modified
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • array-1 property Added
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /employees
  • Body
  • application/json content type Modified
    • firstName, lastName properties Modified
      • Properties are now required
        Breaking
      • Type went from string | null to string
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • firstName, lastName properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to string
            Breaking
POST /offices
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRooms property Added
POST Appointmentwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • message property Modified
        • Property is now deprecated
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
      • previousAppointment property Modified
        • Appointment alternative Modified
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firstName, lastName properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to string
            Breaking
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firstName, lastName properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to string
            Breaking
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
Added 12
DELETE /offices/{officeId}/meeting-rooms/{meetingRoomId}
GET /callback-requests
GET /callback-requests/{id}
GET /files
GET /files/{id}
GET /files/{id}/_actions/download
GET /meeting-rooms
GET /meeting-rooms/{id}
PATCH /callback-requests/{id}
POST /callback-requests
POST /files/_actions/upload
POST /offices/{officeId}/meeting-rooms/{meetingRoomId}
4.3.1
1 structure change including:
1 Modification
Modified 1
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • answers property Added
4.3.0
3 structure changes including:
3 Modifications
Modified 3
GET /schedulable/employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /schedulable/offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /schedulable/subjects
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
4.1.0
17 structure changes including:
17 Modifications
Modified 17
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • Query
  • callback-request-id query parameter Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • Query
  • username query parameter Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • callbackRequestId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • username property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • callbackRequestId property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • callbackRequestId property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /employees
  • Body
  • application/json content type Modified
    • username property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST Appointmentwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified