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

5 days ago

staging
6.0.3
Compare
6.0.3

API structure has changed

Next Change
33 structure changes including:
12 Additions
21 Modifications
Modified 21 Breaking
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
    • array-1 property Modified
      • array-1 property Added
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties 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
    • array-1 property Modified
      • array-1 property Added
    • string-1, string-1, object-1 properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/_actions/invite
  • Body
  • application/json content type Modified
    • string-1, string-1, object-1 properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/cancel
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • array-1 property Added
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/complete
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • array-1 property Added
    • object-1 property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/reassign
  • Body
  • application/json content type Modified
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/request-reschedule
  • Body
  • application/json content type Modified
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
POST /appointments/{id}/_actions/reschedule
  • Body
  • application/json content type Modified
    • array-1 property Modified
      • array-1 property Added
    • string-1, object-1 properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties 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
      • message property Modified
        • Property is now deprecated
      • appointment property Modified
        • Appointment, Incoming request, Outgoing request alternatives Modified
      • previousAppointment property Modified
        • Appointment alternative Modified
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 /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 /appointments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
GET /appointments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • answers property Modified
        • object-1, string-1, userCommunication properties Added
Added 12
DELETE /offices/{officeId}/meeting-rooms/{meetingRoomId}
GET /callback-requests
GET /callback-requests/{id}
GET /files
GET /files/{id}
GET /files/{id}/_actions/download
GET /meeting-rooms
GET /meeting-rooms/{id}
PATCH /callback-requests/{id}
POST /callback-requests
POST /files/_actions/upload
POST /offices/{officeId}/meeting-rooms/{meetingRoomId}