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

Jan 22, 2025

development
5.0.0
Compare
5.0.0

API structure has changed

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