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
4.3.1
1 structure change including:
1 Modification
Modified 1
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • answers property Added
4.3.0
3 structure changes including:
3 Modifications
Modified 3
GET /schedulable/employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /schedulable/offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /schedulable/subjects
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
4.1.0
17 structure changes including:
17 Modifications
Modified 17
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • Query
  • callback-request-id query parameter Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
  • Query
  • username query parameter Added
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • callbackRequestId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • username property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • callbackRequestId property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • callbackRequestId property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /employees
  • Body
  • application/json content type Modified
    • username property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
Webhook POST Appointment
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
3.5.0
13 structure changes including:
13 Modifications
Modified 13
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • hybrid property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • hybrid property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Webhook POST Appointment
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
3.2.11
51 structure changes including:
51 Modifications
Modified 51
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /customers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /customers/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /fetch-configurations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /fetch-configurations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /forms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /forms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /lead-segments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /lead-segments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /listings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /listings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /subject-groups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /subject-groups/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /subjects
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /subjects/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /customers/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /fetch-configurations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /forms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /lead-segments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /listings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /subject-groups/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /subjects/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /customers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /employees
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /fetch-configurations
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /forms
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /forms/{formId}/questions
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /lead-segments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /listings
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /offices
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /subject-groups
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /subjects
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
3.2.10
16 structure changes including:
16 Modifications
Modified 16 Breaking
GET /appointments
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /customers
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /employees
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /employees/{id}/applied-templates
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /employees/{id}/external-calendar-events
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /employees/{id}/favorite-agents
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /employees/{id}/unavailability
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /fetch-configurations
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /forms
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /lead-segments
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /listings
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /listings/{listingId}/time-slots
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /offices
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /subject-groups
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /subjects
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

GET /unavailability
  • Query
  • offset, limit query parameters Modified

    • Full types went from integer to string(positive-integer)

      Breaking

3.2.8
21 structure changes including:
21 Modifications
Modified 21 Breaking
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /lead-segments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /lead-segments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Body
  • application/json content type Modified

    • Content type is no longer required

    • metadata property Modified

      • Property is no longer required

      • metadata property Modified

        • Property is no longer required

    • participants property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • appointmentParticipants property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /lead-segments/{id}
  • Body
  • application/json content type Modified
    • earliestCallbackHours, latestCallbackHours, callbacksAllowed properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /offices/{id}
  • Body
  • application/json content type Modified
    • callbacksAllowed property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • metadata property Modified

      • Property is no longer required

      • metadata property Modified

        • Property is no longer required

    • participants property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • appointmentParticipants property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • metadata property Modified

      • Property is no longer required

      • metadata property Modified

        • Property is no longer required

    • participants property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

    • appointmentParticipants property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /lead-segments
  • Body
  • application/json content type Modified
    • earliestCallbackHours, latestCallbackHours, callbacksAllowed properties Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /offices
  • Body
  • application/json content type Modified
    • callbacksAllowed property Removed

      • Removing a resource is always breaking unless it was deprecated before

        Breaking

  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
Webhook POST Appointment
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
3.2.6
42 structure changes including:
30 Additions
12 Modifications
Modified 12 Breaking
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Body
  • application/json content type Modified

    • Content type is now required

      Breaking

    • metadata property Modified

      • Removing polymorphism is always breaking

        Breaking

  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • metadata property Modified

      • Removing polymorphism is always breaking

        Breaking

  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • metadata property Modified

      • Removing polymorphism is always breaking

        Breaking

  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Added 30
PUT /subjects/{id}/availability-settings
PUT /offices/{id}/subject-availability-settings
PUT /listings/{listingId}/time-slots/{id}
PUT /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges/{id}/availability-settings
POST /listings/{listingId}/time-slots
POST /employees/{id}/unavailability
POST /employees/{id}/applied-templates
POST /employees/{employeeId}/availability-templates/{availabilityTemplateId}/time-ranges
POST /employees/{employeeId}/availability-templates
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}