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.12.0
9 structure changes including:
9 Modifications
Modified 9
GET /subject-groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /subject-groups/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • object-1 property 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
        • object-1 property Added
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
        • object-1 property Added
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • answers property Modified
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • answers property Modified
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
22 structure changes including:
1 Addition
21 Modifications
Modified 21 Breaking
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is now string
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData alternatives Modified
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is now string
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is now string
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is now string
    • data property Modified
      • appointment property Modified
        • uuid property Added
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is now string
    • data property Modified
      • appointment property Modified
        • uuid property Added
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
POST /appointments/{id}/_actions/reschedule
  • 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/reopen
  • 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/complete
  • 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/accept
  • Response
  • 200 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
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ValidatorTranslations, answerOptions properties Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ValidatorTranslations, answerOptions properties Modified
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answerOptions property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
Added 1
POST /appointments/{id}/_actions/update-meeting-type
5 structure changes including:
5 Modifications
Modified 5 Breaking
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is no longer string
        Breaking
    • data property Modified
      • appointment property Modified
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is no longer string
        Breaking
    • data property Modified
      • appointment property Modified
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is no longer string
        Breaking
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is no longer string
        Breaking
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • entity property Modified
      • Type is no longer string
        Breaking
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData alternatives Modified
9.9.0
2 structure changes including:
2 Modifications
Modified 2
GET /offices/{id}/subject-scheduling-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRoomSelection property Added
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
1 structure change including:
1 Breaking change
1 Modification
Modified 1 Breaking
PUT /employees/{employeeId}/offices/{officeId}/expertise
  • Path went from /employees/{employeeId}/office/{officeId}/expertise to /employees/{employeeId}/offices/{officeId}/expertise (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • subjectId, rank properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • object property Added
3 structure changes including:
2 Breaking changes
1 Addition
2 Modifications
Modified 2 Breaking
POST /employees/{id}/unavailability
  • Path went from /employees/{employeeId}/unavailability-event/{id} to /employees/{id}/unavailability (same operationId)
    Breaking
  • Verb went from DELETE to POST (same operationId)
    Breaking
  • Path
  • employeeId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201, 422 responses Added
  • Body
  • application/json content type Added
PUT /employees/{employeeId}/office/{officeId}/expertise
  • Verb went from DELETE to PUT (same operationId)
    Breaking
Added 1
DELETE /employees/{employeeId}/unavailability-event/{id}
9.7.0
3 structure changes including:
2 Breaking changes
1 Addition
2 Modifications
Modified 2 Breaking
DELETE /employees/{employeeId}/unavailability-event/{id}
  • Path went from /employees/{employeeId}/unavailability/{id} to /employees/{employeeId}/unavailability-event/{id} (same operationId)
    Breaking
  • Body
  • application/json content type Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /employees/{id}/unavailability
  • Path went from /employees/{employeeId}/unavailability/{id} to /employees/{id}/unavailability (same operationId)
    Breaking
  • Verb went from DELETE to POST (same operationId)
    Breaking
  • Path
  • employeeId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201, 422 responses Added
Added 1
DELETE /employees/{employeeId}/office/{officeId}/expertise
4 structure changes including:
1 Breaking change
4 Modifications
Modified 4 Breaking
DELETE /employees/{employeeId}/unavailability/{id}
  • Path went from /employees/{id}/unavailability to /employees/{employeeId}/unavailability/{id} (same operationId)
    Breaking
  • Verb went from POST to DELETE (same operationId)
    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
        • id property Added
POST /employees/{id}/unavailability
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Added
POST /employees/{id}/unavailability-event
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Added
9.6.0
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /contexts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1, string-1 properties Modified
          • Properties are no longer required
          • Type went from string(date-time) to string(date-time) | null
        • object-1 property Modified
          • Property is no longer required
GET /employees/{id}/unavailability
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property 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 /contexts
  • Body
  • application/json content type Modified
    • Content type is no longer required
    • string-1, string-1 properties Modified
      • Properties are no longer required
      • Type went from string(date-time) to string(date-time) | null
    • object-1 property Modified
      • Property is no longer required
    • customers property Modified
      • object-1 property Added
    • secondaryCustomers property Modified
      • object-1 property Added
    • expiresAt 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
        • string-1, string-1 properties Modified
          • Properties are no longer required
          • Type went from string(date-time) to string(date-time) | null
        • object-1 property Modified
          • Property is no longer required
POST /employees/{id}/unavailability
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property 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 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
9.5.0
2 structure changes including:
2 Additions
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
9.1.0
5 structure changes including:
1 Addition
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
Added 1
GET /regions
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
16 structure changes including:
16 Modifications
Modified 16 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 /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
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
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
5 structure changes including:
5 Modifications
Modified 5
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • object-1 property Added
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • object-1 property Added
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • object-1 property Added
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • object-1 property Added
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Modified
5 structure changes including:
5 Modifications
Modified 5
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • subject, office, participants, answers, MeetingRoomWebhook properties Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • subject, office, participants, answers, MeetingRoomWebhook properties Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
      • previousAppointment property Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • SubjectWebhook, OfficeWebhook, participants, answers properties Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • SubjectWebhook, OfficeWebhook, participants, answers properties Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Modified