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
6.0.3
2 structure changes including:
1 Breaking change
1 Modification
1 Removal
Modified 1
GET /appointments
  • Query
  • created-from, created-to query parameters Added
Removed 1 Breaking
GET /regions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
5.0.0
15 structure changes including:
15 Modifications
Modified 15 Breaking
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
GET /meeting-rooms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • capacity property Modified
          • Property is now required
            Breaking
          • Type went from integer | null to integer
            Breaking
GET /meeting-rooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • capacity property Modified
          • Property is now required
            Breaking
          • Type went from integer | null to integer
            Breaking
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/complete
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/reassign
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/request-reschedule
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • userCommunication property Added
Webhook POST Appointment
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
      • previousAppointment property Modified
        • Appointment alternative Modified
4.5.7
27 structure changes including:
4 Breaking changes
23 Modifications
4 Removals
Modified 23 Breaking
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
GET /employees
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firstName, lastName properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to string
            Breaking
GET /employees/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firstName, lastName properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to string
            Breaking
GET /meeting-rooms
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
        • isWheelChairAccessible property Modified
          • Property is now required
            Breaking
          • Type went from boolean | null to boolean
            Breaking
        • active, timeZone properties Added
  • Query
  • email, name, provider query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • search query parameter Added
  • Header
  • Accept-Language header Added
GET /meeting-rooms/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • string-1 property Modified
          • Property is no longer required
          • Type went from string to string | null
        • isWheelChairAccessible property Modified
          • Property is now required
            Breaking
          • Type went from boolean | null to boolean
            Breaking
        • active, timeZone properties Added
  • Header
  • Accept-Language header Added
GET /offices
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRooms property Added
GET /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRooms property Added
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
PATCH /employees/{id}
  • Body
  • application/json content type Modified
    • firstName, lastName properties Modified
      • Type went from string | null to string
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • firstName, lastName properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to string
            Breaking
PATCH /offices/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRooms property Added
POST /appointments
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • string-1 property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • object-1 property Added
POST /employees
  • Body
  • application/json content type Modified
    • firstName, lastName properties Modified
      • Properties are now required
        Breaking
      • Type went from string | null to string
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • firstName, lastName properties Modified
          • Properties are now required
            Breaking
          • Type went from string | null to string
            Breaking
POST /offices
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • meetingRooms property Added
Webhook POST Appointment
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
Removed 4 Breaking
DELETE /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /meeting-room-events/_actions/archibus/notification
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /meeting-rooms
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
4.5.5
12 structure changes including:
4 Breaking changes
8 Additions
4 Modifications
Modified 4 Breaking
GET /callback-requests
  • Path went from /callbackRequests to /callback-requests (same operationId)
    Breaking
GET /callback-requests/{id}
  • Path went from /callbackRequests/{id} to /callback-requests/{id} (same operationId)
    Breaking
PATCH /callback-requests/{id}
  • Path went from /callbackRequests/{id} to /callback-requests/{id} (same operationId)
    Breaking
POST /callback-requests
  • Path went from /callbackRequests to /callback-requests (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • status property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
Added 8
DELETE /meeting-rooms/{id}
DELETE /offices/{officeId}/meeting-rooms/{meetingRoomId}
GET /meeting-rooms
GET /meeting-rooms/{id}
PATCH /meeting-rooms/{id}
POST /meeting-room-events/_actions/archibus/notification
POST /meeting-rooms
POST /offices/{officeId}/meeting-rooms/{meetingRoomId}
4.5.4
12 structure changes including:
8 Breaking changes
4 Additions
8 Removals
Removed 8 Breaking
DELETE /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /offices/{officeId}/meeting-rooms/{meetingRoomId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /meeting-rooms
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /meeting-rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /meeting-room-events/_actions/archibus/notification
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /meeting-rooms
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /offices/{officeId}/meeting-rooms/{meetingRoomId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
GET /callbackRequests
GET /callbackRequests/{id}
PATCH /callbackRequests/{id}
POST /callbackRequests
1 structure change including:
1 Breaking change
1 Modification
Modified 1 Breaking
POST /meeting-room-events/_actions/archibus/notification
  • Path went from /meeting-room-events/notification to /meeting-room-events/_actions/archibus/notification (same operationId)
    Breaking
1 structure change including:
1 Addition
Added 1
POST /meeting-room-events/notification
2 structure changes including:
2 Additions
Added 2
DELETE /offices/{officeId}/meeting-rooms/{meetingRoomId}
POST /offices/{officeId}/meeting-rooms/{meetingRoomId}
4.4.1
5 structure changes including:
5 Additions
Added 5
DELETE /meeting-rooms/{id}
GET /meeting-rooms
GET /meeting-rooms/{id}
PATCH /meeting-rooms/{id}
POST /meeting-rooms
4.4.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
    • messageForCustomer property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • messageForCustomer 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
  • Body
  • application/json content type Modified
    • messageForCustomer property Added
  • 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
  • Body
  • application/json content type Modified
    • messageForCustomer property Added
  • 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
  • Body
  • application/json content type Modified
    • messageForCustomer property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • messageForCustomer property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Webhook POST Appointment
  • Body
  • application/json content type Modified
    • data property Modified
      • message property Modified
        • Property is now deprecated
      • appointment property Modified
        • Appointment alternative Modified
17 structure changes including:
4 Additions
13 Modifications
Modified 13
Webhook POST Appointment
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • answers property Modified
  • 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/reopen
  • 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/complete
  • Body
  • application/json content type Modified
    • answers property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • answers property Modified
  • Response
  • 200 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/_actions/invite
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
POST /appointments
  • Body
  • application/json content type Modified
    • answers property Modified
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
PATCH /appointments/{id}
  • Body
  • application/json content type Modified
    • answers property Modified
  • 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 /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Added 4
POST /files/_actions/upload
GET /files/{id}/_actions/download
GET /files/{id}
GET /files
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
20 structure changes including:
20 Modifications
Modified 20
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
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
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
        • Combinator is now oneOf
        • Appointment alternative Modified
        • Incoming request, Outgoing request alternatives Added
      • previousAppointment property Modified
        • Combinator is now oneOf
        • Appointment alternative Modified
        • Incoming request, Outgoing request alternatives Added
1 structure change including:
1 Modification
Modified 1 Breaking
Webhook POST Appointment
  • Body
  • application/json content type Modified
    • data property Modified
      • appointment, previousAppointment properties Modified
        • Removing polymorphism is always breaking
          Breaking
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
12 structure changes including:
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
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