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

Jul 23, 2025

production
9.0.0
Compare
9.0.0

API structure has changed

43 structure changes including:
7 Breaking changes
5 Additions
33 Modifications
5 Removals
Modified 33 Breaking
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • array-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
PATCH /forms/{id}
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
POST /appointments
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /callback-requests
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /employees
  • Body
  • application/json content type Modified
    • array-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
POST /employees/{id}/applied-templates/_actions/revert
  • Path went from /employees/{id}/applied-templates to /employees/{id}/applied-templates/_actions/revert (same operationId)
    Breaking
  • Verb went from DELETE to POST (same operationId)
    Breaking
POST /employees/{id}/unavailability/_actions/revert
  • Path went from /employees/{id}/unavailability to /employees/{id}/unavailability/_actions/revert (same operationId)
    Breaking
  • Verb went from DELETE to POST (same operationId)
    Breaking
POST /forms
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
PUT /employees/{id}/office-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
PUT /employees/{id}/office-subject-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
PUT /subjects/{id}/availability-settings
  • Body
  • application/json content type Modified
    • rank1offset, rank2offset properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • rank1offset, rank2offset properties Added
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /callback-requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
GET /employees/{employeeId}/external-calendar-events
  • Path went from /employees/{id}/external-calendar-events to /employees/{employeeId}/external-calendar-events (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • employeeId path parameter Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • languageExpertise property Added
GET /employees/{id}/office-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
GET /employees/{id}/office-subject-coverage-regions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • regions property Modified
GET /forms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
  • Query
  • external-id query parameter Added
GET /forms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Added
GET /subjects/{id}/availability-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • rank1offset, rank2offset properties Added
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
PATCH /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
Removed 5 Breaking
GET /static-translation-overrides
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /static-translations/{language}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /static-translation-overrides
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Appointmentwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST Pingwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
POST CommunicationWebhookwebhook
POST CallbackRequestUpdatewebhook
POST CallbackRequestCreatewebhook
POST AppointmentUpdatewebhook
POST AppointmentCreatewebhook