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

Mar 23, 2023

development
2.1.1
Compare

API structure has changed

96 structure changes including:
96 Modifications
Modified 96 Breaking
DELETE /customers/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /employees/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /fetch-configurations/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /forms/{formId}/questions/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /forms/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /lead-segments/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /listings/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /offices/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /scim/Users/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /subject-groups/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
DELETE /subjects/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /appointments
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data, meta properties Modified
GET /appointments/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /customers
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • meta property Modified
GET /customers/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /employees
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data, meta properties Modified
GET /employees/profile-picture-url
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /employees/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /employees/{id}/external-calendar-events
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • meta property Modified
GET /employees/{id}/favorite-agents
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data, meta properties Modified
GET /employees/{id}/office-coverage-regions
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /fetch-configurations
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • meta property Modified
GET /fetch-configurations/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /forms
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • meta property Modified
GET /forms/{formId}/questions
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /forms/{formId}/questions/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /forms/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /lead-segments
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • meta property Modified
GET /lead-segments/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /lead-segments/{id}/scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /listings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • meta property Modified
GET /listings/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /listings/{id}/scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /offices
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data, meta properties Modified
GET /offices/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /offices/{id}/expertises
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /offices/{id}/scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /offices/{id}/subject-scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
GET /regions
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /schedulable/employees
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • Additional properties are NOT allowed property Added
GET /schedulable/meeting-types
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • Additional properties are NOT allowed property Added
GET /schedulable/offices
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • Additional properties are NOT allowed property Added
GET /schedulable/subjects
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
    • Additional properties are NOT allowed property Added
GET /scim/Schemas
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • attributes property Modified
    • Additional properties are NOT allowed property Added
GET /scim/Users
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • Resources property Modified
    • Additional properties are NOT allowed property Added
GET /scim/Users/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • name, meta properties Modified
GET /settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /static-translation-overrides
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /static-translations/{language}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /subject-groups
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • meta property Modified
GET /subject-groups/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /subjects
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • meta property Modified
GET /subjects/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
GET /subjects/{id}/scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PATCH /appointments/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • answers property Modified
  • Response
  • 200 response Modified
    • data property Modified
  • 404, 422 responses Added
PATCH /customers/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
PATCH /employees/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • officeRelations property Modified
  • Response
  • 200 response Modified
    • data property Modified
PATCH /fetch-configurations/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PATCH /forms/{formId}/questions/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PATCH /forms/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PATCH /lead-segments/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PATCH /listings/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PATCH /offices/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
PATCH /scim/Users/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • Additional properties are NOT allowed property Removed
  • Response
  • 200 response Modified
    • name, meta properties Modified
PATCH /settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • Additional properties are NOT allowed property Added
PATCH /static-translation-overrides
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • Additional properties are NOT allowed property Added
PATCH /subject-groups/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PATCH /subjects/{id}
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
POST /appointments
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • answers property Modified
  • Response
  • 201 response Modified
    • data property Modified
  • 422 response Added
POST /appointments/_actions/invite
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 201 response Modified
    • data property Modified
  • 422 response Added
POST /appointments/{id}/_actions/accept
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
  • 404, 422 responses Added
POST /appointments/{id}/_actions/cancel
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • answers property Modified
  • Response
  • 200 response Modified
    • data property Modified
  • 404, 422 responses Added
POST /appointments/{id}/_actions/complete
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • answers property Modified
  • Response
  • 200 response Modified
    • data property Modified
  • 404, 422 responses Added
POST /appointments/{id}/_actions/reassign
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
  • 404, 422 responses Added
POST /appointments/{id}/_actions/reopen
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
  • 404, 422 responses Added
POST /appointments/{id}/_actions/request-reschedule
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
  • 404, 422 responses Added
POST /appointments/{id}/_actions/reschedule
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
  • 404, 422 responses Added
POST /customers
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 201 response Modified
    • data property Modified
POST /employees
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • officeRelations property Modified
  • Response
  • 201 response Modified
    • data property Modified
POST /fetch-configurations
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
POST /forms
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
POST /forms/{formId}/questions
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
POST /lead-segments
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
POST /listings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
POST /offices
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 201 response Modified
    • data property Modified
POST /scim/Users
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Body
  • content type Modified
    • Additional properties are NOT allowed property Removed
  • Response
  • 201 response Modified
    • name, meta properties Modified
POST /subject-groups
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
POST /subjects
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PUT /employees/{id}/favorite-agents
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
PUT /employees/{id}/office-coverage-regions
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
PUT /lead-segments/{id}/scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
PUT /listings/{id}/scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
PUT /offices/{id}/expertises
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
PUT /offices/{id}/scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
PUT /offices/{id}/subject-scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified
  • Response
  • 200 response Modified
    • data property Modified
PUT /subjects/{id}/scheduling-settings
  • Header
  • Accept-Language, Authorization, X-Correlation-Id headers Modified