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

Aug 30, 2023

development
3.0.1
Compare
3.0.1

API structure has changed

97 structure changes including:
32 Additions
65 Modifications
Modified 65 Breaking
PUT /subjects/{id}/scheduling-settings
  • Response
  • 422 response Removed
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 /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
Webhook POST Appointment
  • Body
  • content type Modified
    • data property Modified
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