Change Updates

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
9.7.0
11 structure changes including:
1 Breaking change
2 Additions
9 Modifications
Modified 9 Breaking
DELETE /employees/{employeeId}/unavailability-event/{id}
  • Path went from /employees/{id}/unavailability to /employees/{employeeId}/unavailability-event/{id} (same operationId)
    Breaking
  • Verb went from POST to DELETE (same operationId)
    Breaking
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 201, 422 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204 response Added
  • Path
  • employeeId path parameter Added
GET /employees/{id}/unavailability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers, id properties Added
GET /listings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
GET /listings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
GET /unavailability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers 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
POST /employees/{id}/unavailability
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • answers, id properties Added
POST /employees/{id}/unavailability-event
  • Body
  • application/json content type Modified
    • array-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • answers, id properties 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
Added 2
GET /contexts/{id}
POST /contexts
2 structure changes including:
2 Modifications
Modified 2
GET /employees
  • 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
9.4.0
11 structure changes including:
11 Modifications
Modified 11
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-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
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
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
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 AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • office, participants properties Modified
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • office, participants properties Modified
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • OfficeWebhook, participants properties Modified
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • OfficeWebhook, participants properties Modified
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Modified
9.3.0
1 structure change including:
1 Addition
Added 1
POST /employees/{id}/unavailability-event
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
4 structure changes including:
4 Modifications
Modified 4
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
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
8.0.0
26 structure changes including:
4 Breaking changes
5 Additions
19 Modifications
2 Removals
Modified 19 Breaking
POST /appointments/{id}/_actions/reschedule
  • 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/reopen
  • 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/complete
  • 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/accept
  • Response
  • 200 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
  • 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 /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property 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
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 /callback-requests/{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 /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /appointments
  • 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/{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
Removed 2 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.3.0
13 structure changes including:
3 Breaking changes
10 Modifications
3 Removals
Modified 10
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
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 /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 /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 /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 /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
Removed 3 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
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.1.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
3.5.0
13 structure changes including:
13 Modifications
Modified 13
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • hybrid property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • hybrid 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 Appointmentwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
3.2.11
51 structure changes including:
51 Modifications
Modified 51
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /customers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /customers/{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
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /fetch-configurations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /fetch-configurations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /forms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /forms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /lead-segments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /lead-segments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /listings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /listings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /subject-groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /subject-groups/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /subjects
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /subjects/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /customers/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /fetch-configurations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /forms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /lead-segments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /listings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /subject-groups/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /subjects/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • 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 /customers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /employees
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /fetch-configurations
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /forms
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /forms/{formId}/questions
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /lead-segments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /listings
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /offices
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /subject-groups
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /subjects
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
3.2.10
16 structure changes including:
16 Modifications
Modified 16 Breaking
GET /appointments
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /customers
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /employees
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /employees/{id}/applied-templates
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /employees/{id}/external-calendar-events
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /employees/{id}/favorite-agents
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /employees/{id}/unavailability
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /fetch-configurations
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /forms
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /lead-segments
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /listings
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /listings/{listingId}/time-slots
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /offices
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /subject-groups
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /subjects
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
GET /unavailability
  • Query
  • offset, limit query parameters Modified
    • Full types went from integer to string(positive-integer)
      Breaking
3.2.8
21 structure changes including:
21 Modifications
Modified 21 Breaking
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /lead-segments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /lead-segments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • metadata property Modified
      • Property is no longer required
      • metadata property Modified
        • Property is no longer required
    • participants property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • appointmentParticipants property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /lead-segments/{id}
  • Body
  • application/json content type Modified
    • earliestCallbackHours, latestCallbackHours, callbacksAllowed properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /offices/{id}
  • Body
  • application/json content type Modified
    • callbacksAllowed property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • metadata property Modified
      • Property is no longer required
      • metadata property Modified
        • Property is no longer required
    • participants property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • appointmentParticipants property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • metadata property Modified
      • Property is no longer required
      • metadata property Modified
        • Property is no longer required
    • participants property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • appointmentParticipants 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 /lead-segments
  • Body
  • application/json content type Modified
    • earliestCallbackHours, latestCallbackHours, callbacksAllowed properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /offices
  • Body
  • application/json content type Modified
    • callbacksAllowed property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 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