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
19 structure changes including:
19 Modifications
Modified 19
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
GET /callback-requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
GET /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
PATCH /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
POST /appointments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-details
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-location
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-meeting-type
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /callback-requests
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
19 structure changes including:
19 Modifications
Modified 19
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
GET /callback-requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
GET /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
PATCH /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
POST /appointments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-details
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-location
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-meeting-type
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /callback-requests
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
10.10.2
19 structure changes including:
19 Modifications
Modified 19
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
GET /callback-requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
GET /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
PATCH /callback-requests/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
POST /appointments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-details
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-location
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /appointments/{id}/_actions/update-meeting-type
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • appointmentParticipants property Modified
POST /callback-requests
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • callbackRequestParticipants property Modified
10.9.1
9 structure changes including:
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
1 structure change including:
1 Modification
Modified 1
POST /appointments/{id}/_actions/update-details
  • Body
  • application/json content type Modified
    • officeId property Added
1 structure change including:
1 Addition
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.7.2
10.6.1
10.5.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
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