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
3.2.3
30 structure changes including:
30 Additions
Added 30
DELETE /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
DELETE /employees/{employeeId}/availability-templates/{id}
DELETE /employees/{id}/applied-templates
DELETE /employees/{id}/unavailability
DELETE /listings/{listingId}/time-slots/{id}
GET /defined-availability
GET /employees/{employeeId}/availability-templates
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
GET /employees/{employeeId}/availability-templates/{id}
GET /employees/{id}/applied-templates
GET /employees/{id}/unavailability
GET /listings/{listingId}/time-slots
GET /listings/{listingId}/time-slots/{id}
GET /offices/{id}/subject-availability-settings
GET /subjects/{id}/availability-settings
GET /timetable
GET /unavailability
PATCH /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
PATCH /employees/{employeeId}/availability-templates/{id}
POST /employees/{employeeId}/availability-templates
POST /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
POST /employees/{id}/applied-templates
POST /employees/{id}/unavailability
POST /listings/{listingId}/time-slots
PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
PUT /listings/{listingId}/time-slots/{id}
PUT /offices/{id}/subject-availability-settings
PUT /subjects/{id}/availability-settings
30 structure changes including:
30 Breaking changes
30 Removals
Removed 30 Breaking
DELETE /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
DELETE /employees/{employeeId}/availability-templates/{id}
DELETE /employees/{id}/applied-templates
DELETE /employees/{id}/unavailability
DELETE /listings/{listingId}/time-slots/{id}
GET /defined-availability
GET /employees/{employeeId}/availability-templates
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
GET /employees/{employeeId}/availability-templates/{id}
GET /employees/{id}/applied-templates
GET /employees/{id}/unavailability
GET /listings/{listingId}/time-slots
GET /listings/{listingId}/time-slots/{id}
GET /offices/{id}/subject-availability-settings
GET /subjects/{id}/availability-settings
GET /timetable
GET /unavailability
PATCH /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
PATCH /employees/{employeeId}/availability-templates/{id}
POST /employees/{employeeId}/availability-templates
POST /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
POST /employees/{id}/applied-templates
POST /employees/{id}/unavailability
POST /listings/{listingId}/time-slots
PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
PUT /listings/{listingId}/time-slots/{id}
PUT /offices/{id}/subject-availability-settings
PUT /subjects/{id}/availability-settings
3.0.1
97 structure changes including:
32 Additions
65 Modifications
Modified 65 Breaking
POST Appointmentwebhook
  • Body
  • content type Modified
    • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • data property Modified
POST /appointments
  • Body
  • content type Modified
    • answers property Modified
  • Response
  • 201 response Modified
    • data property Modified
PATCH /subjects/{id}
  • Response
  • 200 response Modified
    • data property Modified
  • 422 response Removed
PATCH /subject-groups/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /offices/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /listings/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /lead-segments/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /forms/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /fetch-configurations/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /employees/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /customers/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /appointments/{id}
  • Body
  • content type Modified
    • answers property Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /subjects/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /subjects
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /subject-groups/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /subject-groups
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /plugin/{intent}/{token}
  • Header
  • Authorization, X-Correlation-Id headers Removed
  • Response
  • 200 response Removed
  • 302 response Added
GET /offices/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /offices
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /listings/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /listings
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /appointments
  • Response
  • 200 response Modified
    • data property Modified
PUT /subjects/{id}/scheduling-settings
  • Response
  • 422 response Removed
PUT /offices/{id}/subject-scheduling-settings
  • Response
  • 422 response Removed
PUT /offices/{id}/scheduling-settings
  • Response
  • 422 response Removed
PUT /offices/{id}/expertises
  • Response
  • 422 response Removed
PUT /lead-segments/{id}/scheduling-settings
  • Response
  • 422 response Removed
PUT /employees/{id}/office-subject-coverage-regions
  • Response
  • 422 response Removed
PUT /employees/{id}/office-coverage-regions
  • Response
  • 422 response Removed
PUT /employees/{id}/favorite-agents
  • Response
  • 422 response Removed
POST /subjects
  • Response
  • 201 response Modified
    • data property Modified
  • 422 response Removed
POST /subject-groups
  • Response
  • 201 response Modified
    • data property Modified
POST /offices
  • Response
  • 201 response Modified
    • data property Modified
POST /listings
  • Response
  • 201 response Modified
    • data property Modified
POST /lead-segments
  • Response
  • 201 response Modified
    • data property Modified
POST /forms/{formId}/questions
  • Response
  • 201 response Modified
    • data property Modified
POST /forms
  • Response
  • 201 response Modified
    • data property Modified
POST /fetch-configurations
  • Response
  • 201 response Modified
    • data property Modified
POST /employees
  • Response
  • 201 response Modified
    • data property Modified
POST /customers
  • Response
  • 201 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reassign
  • Body
  • content type Modified
    • message property Added
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/complete
  • Body
  • content type Modified
    • answers property Modified
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/cancel
  • Body
  • content type Modified
    • answers property Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /calendar-event/google/{token}
  • Header
  • Authorization, X-Correlation-Id headers Removed
  • Response
  • 200 response Removed
  • 302 response Added
GET /calendar-event/ical/{token}
  • Header
  • Authorization, X-Correlation-Id headers Removed
GET /calendar-event/office365/{token}
  • Header
  • Authorization, X-Correlation-Id headers Removed
  • Response
  • 200 response Removed
  • 302 response Added
GET /customers
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /customers/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /employees
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /lead-segments/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /lead-segments
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /forms/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /forms
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • with-deleted query parameter Added
GET /fetch-configurations/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /fetch-configurations
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • id, with-deleted query parameters Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • data property Modified
Added 32
GET /offices/{id}/subject-availability-settings
GET /listings/{listingId}/time-slots/{id}
GET /listings/{listingId}/time-slots
GET /employees/{id}/unavailability
GET /employees/{id}/applied-templates
GET /employees/{employeeId}/availability-templates/{id}
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
GET /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
GET /employees/{employeeId}/availability-templates
GET /defined-availability
DELETE /listings/{listingId}/time-slots/{id}
DELETE /employees/{id}/unavailability
DELETE /employees/{id}/applied-templates
DELETE /employees/{employeeId}/availability-templates/{id}
DELETE /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
GET /subjects/{id}/availability-settings
GET /timetable
GET /unavailability
GET /video/{token}
GET /video/{token}/test
PATCH /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}
PATCH /employees/{employeeId}/availability-templates/{id}
POST /employees/{employeeId}/availability-templates
POST /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
POST /employees/{id}/applied-templates
POST /employees/{id}/unavailability
POST /listings/{listingId}/time-slots
PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
PUT /listings/{listingId}/time-slots/{id}
PUT /offices/{id}/subject-availability-settings
PUT /subjects/{id}/availability-settings
8 structure changes including:
4 Additions
4 Modifications
Modified 4
PATCH /appointments/{id}
  • Body
  • content type Modified
    • location property Modified
PATCH /customers/{id}
  • Body
  • content type Modified
    • location property Modified
PATCH /listings/{id}
  • Body
  • content type Modified
    • location property Modified
PATCH /offices/{id}
  • Body
  • content type Modified
    • location property Modified
Added 4
GET /calendar-event/google/{token}
GET /calendar-event/ical/{token}
GET /calendar-event/office365/{token}
GET /plugin/{intent}/{token}
1 structure change including:
1 Modification
Modified 1
POST Appointmentwebhook
  • Body
  • content type Modified
    • data property Modified
1 structure change including:
1 Modification
Modified 1
POST Appointmentwebhook
  • Body
  • content type Modified
    • data property Modified
8 structure changes including:
8 Modifications
Modified 8
PATCH /appointments/{id}
  • Body
  • content type Modified
    • location property Modified
PATCH /customers/{id}
  • Body
  • content type Modified
    • location property Modified
PATCH /employees/{id}
  • Body
  • content type Modified
    • translations property Modified
PATCH /forms/{formId}/questions/{id}
  • Body
  • content type Modified
    • validator, translations properties Modified
PATCH /listings/{id}
  • Body
  • content type Modified
    • translations, location properties Modified
PATCH /offices/{id}
  • Body
  • content type Modified
    • translations, location properties Modified
PATCH /subject-groups/{id}
  • Body
  • content type Modified
    • translations property Modified
PATCH /subjects/{id}
  • Body
  • content type Modified
    • translations property Modified
3 structure changes including:
1 Breaking change
2 Additions
1 Removal
Removed 1 Breaking
POST eventwebhook
Added 2
POST Appointmentwebhook
POST Pingwebhook
1 structure change including:
1 Modification
Modified 1 Breaking
POST eventwebhook
  • Body
  • content type Modified
    • Appointment alternative Modified
      • id, correlationId, webhookConfigurationId, version properties Added
    • object-2 alternative Removed
    • Ping alternative Added
2 structure changes including:
1 Addition
1 Modification
Modified 1 Breaking
POST /employees/{id}/_actions/reset
  • Header
  • Accept-Language header Removed
Added 1
POST eventwebhook
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /forms
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /forms/{id}
  • Body
  • content type Modified
    • translations property Removed
    • name property Added
  • Response
  • 200 response Modified
    • data property Modified
POST /forms
  • Body
  • content type Modified
    • translations property Removed
    • name property Added
  • Response
  • 201 response Modified
    • data property Modified
1 structure change including:
1 Addition
Added 1
POST /employees/{id}/_actions/reset
8 structure changes including:
8 Modifications
Modified 8
DELETE /fetch-configurations/{id}
  • Response
  • 422 response Added
DELETE /subject-groups/{id}
  • Response
  • 422 response Added
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /subjects/{id}/scheduling-settings
  • Response
  • 404 response Added
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • data property Modified
POST /forms/{formId}/questions
  • Response
  • 201 response Modified
    • data property Modified
PUT /subjects/{id}/scheduling-settings
  • Response
  • 404, 422 responses Added
25 structure changes including:
25 Modifications
Modified 25
GET /appointments
  • Response
  • 200 response Modified
    • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /customers
  • Response
  • 200 response Modified
    • data property Modified
GET /customers/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /listings
  • Response
  • 200 response Modified
    • data property Modified
GET /listings/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /offices
  • Response
  • 200 response Modified
    • data property Modified
GET /offices/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /schedulable/offices
  • Response
  • 200 response Modified
    • data property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /customers/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /listings/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /offices/{id}
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments
  • Response
  • 201 response Modified
    • data property Modified
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • data property Modified
POST /customers
  • Response
  • 201 response Modified
    • data property Modified
POST /listings
  • Response
  • 201 response Modified
    • data property Modified
POST /offices
  • Response
  • 201 response Modified
    • data property Modified
1 structure change including:
1 Modification
Modified 1
PATCH /settings
  • Body
  • content type Modified
    • Additional properties: property Modified
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /regions
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Body
  • content type Modified
    • start, end properties Modified
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /settings
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • key, manageable query parameters Removed
PATCH /settings
  • Body
  • content type Modified
    • key, manageable, value, Additional properties are NOT allowed properties Removed
    • Additional properties: property Added
  • Response
  • 200 response Modified
    • data property Modified
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /settings
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • key, manageable query parameters Removed
PATCH /settings
  • Body
  • content type Modified
    • key, manageable, value, Additional properties are NOT allowed properties Removed
    • Additional properties: property Added
  • Response
  • 200 response Modified
    • data property Modified
44 structure changes including:
44 Modifications
Modified 44 Breaking
DELETE /fetch-configurations/{id}
  • Header
  • Accept-Language header Removed
DELETE /lead-segments/{id}
  • Header
  • Accept-Language header Removed
DELETE /subject-groups/{id}
  • Response
  • 404 response Added
DELETE /subjects/{id}
  • Response
  • 404 response Added
GET /employees/{id}/external-calendar-events
  • Header
  • Accept-Language header Removed
GET /employees/{id}/favorite-agents
  • Header
  • Accept-Language header Removed
GET /employees/{id}/office-coverage-regions
  • Header
  • Accept-Language header Removed
GET /employees/{id}/office-subject-coverage-regions
  • Header
  • Accept-Language header Removed
GET /fetch-configurations
  • Header
  • Accept-Language header Removed
GET /fetch-configurations/{id}
  • Header
  • Accept-Language header Removed
GET /lead-segments
  • Header
  • Accept-Language header Removed
GET /lead-segments/{id}
  • Header
  • Accept-Language header Removed
GET /lead-segments/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
GET /listings/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
GET /offices/{id}/expertises
  • Header
  • Accept-Language header Removed
GET /offices/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
GET /offices/{id}/subject-scheduling-settings
  • Header
  • Accept-Language header Removed
GET /regions
  • Header
  • Accept-Language header Removed
GET /schedulable/meeting-types
  • Header
  • Accept-Language header Removed
GET /settings
  • Header
  • Accept-Language header Removed
GET /static-translation-overrides
  • Header
  • Accept-Language header Removed
GET /static-translations/{language}
  • Header
  • Accept-Language header Removed
GET /subject-groups/{id}
  • Response
  • 404 response Added
GET /subjects/{id}
  • Response
  • 404 response Added
GET /subjects/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
PATCH /fetch-configurations/{id}
  • Header
  • Accept-Language header Removed
PATCH /lead-segments/{id}
  • Header
  • Accept-Language header Removed
PATCH /settings
  • Header
  • Accept-Language header Removed
PATCH /static-translation-overrides
  • Header
  • Accept-Language header Removed
  • Response
  • 422 response Added
PATCH /subject-groups/{id}
  • Response
  • 404, 422 responses Added
PATCH /subjects/{id}
  • Response
  • 404, 422 responses Added
POST /fetch-configurations
  • Header
  • Accept-Language header Removed
POST /lead-segments
  • Header
  • Accept-Language header Removed
POST /subject-groups
  • Response
  • 422 response Added
POST /subjects
  • Response
  • 422 response Added
PUT /employees/{id}/favorite-agents
  • Header
  • Accept-Language header Removed
PUT /employees/{id}/office-coverage-regions
  • Header
  • Accept-Language header Removed
PUT /employees/{id}/office-subject-coverage-regions
  • Header
  • Accept-Language header Removed
PUT /lead-segments/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
PUT /listings/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
PUT /offices/{id}/expertises
  • Header
  • Accept-Language header Removed
PUT /offices/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
PUT /offices/{id}/subject-scheduling-settings
  • Header
  • Accept-Language header Removed
PUT /subjects/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
1 structure change including:
1 Modification
Modified 1
PATCH /settings
  • Response
  • 422 response Added