For AI agents: a documentation index is available at https://developer.pexipengage.com/development/llms.txt. Markdown versions of each page are available by sending an Accept: text/markdown header, or by appending .md to the page URL.

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
9 structure changes including:
1 Addition
8 Modifications
Modified 8 Breaking
GET /contexts/resolve
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • end, start properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • timetableFrom, timetableTo properties Added
GET /contexts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • end, start properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • timetableFrom, timetableTo properties Added
PATCH /contexts/{id}
  • Body
  • application/json content type Modified
    • end, start properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • timetableFrom, timetableTo properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • end, start properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • timetableFrom, timetableTo properties Added
POST /appointments
  • Body
  • application/json content type Modified
    • rules property Added
POST /appointments/{id}/_actions/reassign
  • Body
  • application/json content type Modified
    • rules property Added
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • rules property Added
POST /appointments/{id}/_actions/update-details
  • Body
  • application/json content type Modified
    • rules property Added
POST /contexts
  • Body
  • application/json content type Modified
    • end, start properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • timetableFrom, timetableTo properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • end, start properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • timetableFrom, timetableTo properties Added
Added 1
POST /appointments/{id}/_actions/change-primary-customer
11 structure changes including:
4 Additions
7 Modifications
Modified 7
GET /contexts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • expiresAt property Modified
          • Property is no longer required
          • Type went from string(date-time) to string(date-time) | null
        • name, slug, ownerType, ownerId, persistent properties Added
POST /contexts
  • Body
  • application/json content type Modified
    • name, slug, persistent properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • expiresAt property Modified
          • Property is no longer required
          • Type went from string(date-time) to string(date-time) | null
        • name, slug, ownerType, ownerId, persistent properties Added
POST AppointmentCreate webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • answers property Modified
POST AppointmentUpdate webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • answers property Modified
POST CallbackRequestCreate webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • answers property Modified
POST CallbackRequestUpdate webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • answers property Modified
POST CommunicationWebhook webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • resource property Modified
        • AppointmentCreateWebhookData, AppointmentUpdateWebhookData, CallbackRequestCreateWebhookData, CallbackRequestUpdateWebhookData alternatives Modified
Added 4
DELETE /contexts/{id}
GET /contexts
GET /contexts/resolve
PATCH /contexts/{id}
1 structure change including:
1 Modification
Modified 1
GET /timetable
  • Query
  • ignore-appointment query parameter Added
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
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
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 AppointmentCreate webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • participants property Modified
POST AppointmentUpdate webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • participants property Modified
POST CallbackRequestCreate webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • participants property Modified
POST CallbackRequestUpdate webhook
  • Body
  • application/json content type Modified
    • data property Modified
      • callbackRequest property Modified
        • participants property Modified
POST CommunicationWebhook webhook
  • 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
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
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
1 structure change including:
1 Addition
Added 1
POST PingWebhook webhook