Do not miss any Pexip Engage API changes, ever again

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

RSS

Changelog

Last update:
Compare
10.10.2
10.10.0
10 structure changes including:
1 Addition
9 Modifications
Modified 9
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • description property Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • translations property Modified
      • description property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
POST /employees
  • Body
  • application/json content type Modified
    • translations property Modified
      • description property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • translations property Modified
        • description property Added
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • participants property Modified
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • participants property Modified
POST CallbackRequestCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • participants property Modified
POST CallbackRequestUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • participants property Modified
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Modified
Added 1
POST /appointments/{id}/_actions/update-details
10.8.3
32 structure changes including:
32 Modifications
Modified 32 Breaking
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /customers/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /employees/{employeeId}/availability-templates/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /fetch-configurations/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /forms/{formId}/questions/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /forms/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /lead-segments/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /listings/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /offices/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /subject-groups/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PATCH /subjects/{id}
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /appointments/{id}/_actions/complete
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /appointments/{id}/_actions/request-reschedule
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /contexts
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
POST /customers
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{employeeId}/offices/{officeId}/expertise
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{id}/favorite-agents
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{id}/office-coverage-regions
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /employees/{id}/office-subject-coverage-regions
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /lead-segments/{id}/scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /listings/{id}/scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /offices/{id}/expertises
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /offices/{id}/scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /offices/{id}/subject-availability-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /offices/{id}/subject-scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /subjects/{id}/availability-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
PUT /subjects/{id}/scheduling-settings
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
10.6.1
10.5.0
1 structure change including:
1 Modification
Modified 1
GET /data-export/conversion-analytics-sessions
  • Query
  • intent query parameter Added
10.4.0
3 structure changes including:
1 Breaking change
2 Additions
1 Removal
Removed 1 Breaking
GET /data-export/{resource}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
GET /data-export/appointments
GET /data-export/conversion-analytics-sessions
10.2.4
1 structure change including:
1 Addition
Added 1
POST PingWebhookwebhook
10.2.3
10.2.1
1 structure change including:
1 Addition
Added 1
POST /appointments/{id}/_actions/update-location
10.1.0
9 structure changes including:
9 Modifications
Modified 9
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
POST /appointments
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
POST /appointments/{id}/_actions/complete
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
POST /appointments/{id}/_actions/reassign
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
POST /appointments/{id}/_actions/request-reschedule
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
POST /appointments/{id}/_actions/update-meeting-type
  • Body
  • application/json content type Modified
    • string-1, string-1 properties Added
10.0.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.11.0
16 structure changes including:
16 Modifications
Modified 16
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST /appointments/{id}/_actions/update-meeting-type
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • uuid property Added
POST AppointmentCreatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • uuid property Added
POST AppointmentUpdatewebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • uuid property Added
POST CommunicationWebhookwebhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData alternatives Modified
9.10.0
5 structure changes including:
1 Addition
4 Modifications
Modified 4 Breaking
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answerOptions property Modified
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ValidatorTranslations, answerOptions properties Modified
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ValidatorTranslations, answerOptions properties Modified
POST /forms/{formId}/questions
  • Body
  • application/json content type Modified
    • object-1 property Modified
      • translations property Modified
        • errorMessage property Modified
          • Property is now required
            Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • ValidatorTranslations, answerOptions properties Modified
Added 1
POST /appointments/{id}/_actions/update-meeting-type
9.9.1
5 structure changes including:
1 Breaking change
2 Additions
3 Modifications
Modified 3 Breaking
GET /offices/{id}/subject-scheduling-settings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRoomSelection property Added
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 /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
Added 2
DELETE /employees/{employeeId}/unavailability-event/{id}
PUT /employees/{employeeId}/offices/{officeId}/expertise
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