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
1 structure change including:
1 Modification
Modified 1 Breaking
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhook, AppointmentUpdateWebhook, CallbackRequestCreateWebhook, CallbackRequestUpdateWebhook alternatives Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Added
5 structure changes including:
3 Additions
2 Modifications
Modified 2 Breaking
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • eventType, string-1, appointment, previousAppointment properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • id, correlationId, entity, version, webhookConfigurationId, data properties Added
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • eventType, string-1, appointment, previousAppointment properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • id, correlationId, entity, version, webhookConfigurationId, data properties Added
Added 3
POST CallbackRequestCreatewebhook
POST CallbackRequestUpdatewebhook
POST CommunicationWebhookwebhook
2 structure changes including:
2 Modifications
Modified 2
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • property Added
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • property Added
2 structure changes including:
2 Modifications
Modified 2
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • property Removed
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • property Removed
5 structure changes including:
3 Breaking changes
2 Additions
2 Modifications
1 Removal
Modified 2 Breaking
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 1 Breaking
POST Appointmentwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST AppointmentCreatewebhook
POST AppointmentUpdatewebhook
1 structure change including:
1 Modification
Modified 1
POST Appointmentwebhook
  • Body
  • application/json content type Modified
    • property Added
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
POST appointment.createwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST Appointmentwebhook
3 structure changes including:
2 Breaking changes
1 Addition
2 Removals
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 1
POST appointment.createwebhook
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
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.0.1
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
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /appointments
  • Query
  • created-from, created-to query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 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
6.0.3
2 structure changes including:
1 Breaking change
1 Modification
1 Removal
Modified 1
GET /appointments
  • Query
  • created-from, created-to query parameters Added
Removed 1 Breaking
GET /regions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
5.0.0
15 structure changes including:
15 Modifications
Modified 15 Breaking
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
GET /meeting-rooms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • capacity property Modified
          • Property is now required
            Breaking
          • Type went from integer | null to integer
            Breaking
GET /meeting-rooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • capacity property Modified
          • Property is now required
            Breaking
          • Type went from integer | null to integer
            Breaking
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication 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
        • userCommunication 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
        • userCommunication property Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/complete
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/reassign
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/request-reschedule
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST Appointmentwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
      • previousAppointment property Modified
        • Appointment alternative Modified
4.5.7
27 structure changes including:
4 Breaking changes
23 Modifications
4 Removals
Modified 23 Breaking
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 /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 /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 /meeting-rooms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
        • isWheelChairAccessible property Modified
          • Property is now required
            Breaking
          • Type went from boolean | null to boolean
            Breaking
        • active, timeZone properties Added
  • Query
  • email, name, provider query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • search query parameter Added
  • Header
  • Accept-Language header Added
GET /meeting-rooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
        • isWheelChairAccessible property Modified
          • Property is now required
            Breaking
          • Type went from boolean | null to boolean
            Breaking
        • active, timeZone properties Added
  • Header
  • Accept-Language header Added
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
    • string-1 property Added
  • 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
    • 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
    • string-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
    • string-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 /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
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
Removed 4 Breaking
DELETE /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /meeting-room-events/_actions/archibus/notification
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /meeting-rooms
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
4.5.5
12 structure changes including:
4 Breaking changes
8 Additions
4 Modifications
Modified 4 Breaking
GET /callback-requests
  • Path went from /callbackRequests to /callback-requests (same operationId)
    Breaking
GET /callback-requests/{id}
  • Path went from /callbackRequests/{id} to /callback-requests/{id} (same operationId)
    Breaking
PATCH /callback-requests/{id}
  • Path went from /callbackRequests/{id} to /callback-requests/{id} (same operationId)
    Breaking
POST /callback-requests
  • Path went from /callbackRequests to /callback-requests (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • status property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
Added 8
DELETE /meeting-rooms/{id}
DELETE /offices/{officeId}/meeting-rooms/{meetingRoomId}
GET /meeting-rooms
GET /meeting-rooms/{id}
PATCH /meeting-rooms/{id}
POST /meeting-room-events/_actions/archibus/notification
POST /meeting-rooms
POST /offices/{officeId}/meeting-rooms/{meetingRoomId}
4.5.4
12 structure changes including:
8 Breaking changes
4 Additions
8 Removals
Removed 8 Breaking
DELETE /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /offices/{officeId}/meeting-rooms/{meetingRoomId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /meeting-rooms
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /meeting-room-events/_actions/archibus/notification
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /meeting-rooms
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /offices/{officeId}/meeting-rooms/{meetingRoomId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
GET /callbackRequests
GET /callbackRequests/{id}
PATCH /callbackRequests/{id}
POST /callbackRequests
1 structure change including:
1 Breaking change
1 Modification
Modified 1 Breaking
POST /meeting-room-events/_actions/archibus/notification
  • Path went from /meeting-room-events/notification to /meeting-room-events/_actions/archibus/notification (same operationId)
    Breaking
1 structure change including:
1 Addition
Added 1
POST /meeting-room-events/notification