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
1 structure change including:
1 Modification
Modified 1
Webhook POST Appointment
  • Body
  • content type Modified
    • data property Modified
1 structure change including:
1 Modification
Modified 1
Webhook POST Appointment
  • Body
  • content type Modified
    • data property Modified
8 structure changes including:
8 Modifications
Modified 8
PATCH /appointments/{id}
  • Body
  • content type Modified
    • location property Modified
PATCH /customers/{id}
  • Body
  • content type Modified
    • location property Modified
PATCH /employees/{id}
  • Body
  • content type Modified
    • translations property Modified
PATCH /forms/{formId}/questions/{id}
  • Body
  • content type Modified
    • validator, translations properties Modified
PATCH /listings/{id}
  • Body
  • content type Modified
    • translations, location properties Modified
PATCH /offices/{id}
  • Body
  • content type Modified
    • translations, location properties Modified
PATCH /subject-groups/{id}
  • Body
  • content type Modified
    • translations property Modified
PATCH /subjects/{id}
  • Body
  • content type Modified
    • translations property Modified
3 structure changes including:
1 Breaking change
2 Additions
1 Removal
Removed 1 Breaking
Webhook POST event
Added 2
Webhook POST Appointment
Webhook POST Ping
1 structure change including:
1 Modification
Modified 1 Breaking
Webhook POST event
  • Body
  • content type Modified
    • Appointment alternative Modified
      • id, correlationId, webhookConfigurationId, version properties Added
    • object-2 alternative Removed
    • Ping alternative Added
2 structure changes including:
1 Addition
1 Modification
Modified 1 Breaking
POST /employees/{id}/_actions/reset
  • Header
  • Accept-Language header Removed
Added 1
Webhook POST event
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /forms
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /forms/{id}
  • Body
  • content type Modified
    • translations property Removed
    • name property Added
  • Response
  • 200 response Modified
    • data property Modified
POST /forms
  • Body
  • content type Modified
    • translations property Removed
    • name property Added
  • Response
  • 201 response Modified
    • data property Modified
1 structure change including:
1 Addition
Added 1
POST /employees/{id}/_actions/reset
8 structure changes including:
8 Modifications
Modified 8
DELETE /fetch-configurations/{id}
  • Response
  • 422 response Added
DELETE /subject-groups/{id}
  • Response
  • 422 response Added
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /subjects/{id}/scheduling-settings
  • Response
  • 404 response Added
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • data property Modified
POST /forms/{formId}/questions
  • Response
  • 201 response Modified
    • data property Modified
PUT /subjects/{id}/scheduling-settings
  • Response
  • 404, 422 responses Added
25 structure changes including:
25 Modifications
Modified 25
GET /appointments
  • Response
  • 200 response Modified
    • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /customers
  • Response
  • 200 response Modified
    • data property Modified
GET /customers/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /listings
  • Response
  • 200 response Modified
    • data property Modified
GET /listings/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /offices
  • Response
  • 200 response Modified
    • data property Modified
GET /offices/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /schedulable/offices
  • Response
  • 200 response Modified
    • data property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /customers/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /listings/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /offices/{id}
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments
  • Response
  • 201 response Modified
    • data property Modified
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • data property Modified
POST /customers
  • Response
  • 201 response Modified
    • data property Modified
POST /listings
  • Response
  • 201 response Modified
    • data property Modified
POST /offices
  • Response
  • 201 response Modified
    • data property Modified
1 structure change including:
1 Modification
Modified 1
PATCH /settings
  • Body
  • content type Modified
    • Additional properties: property Modified
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /regions
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Body
  • content type Modified
    • start, end properties Modified
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /settings
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • key, manageable query parameters Removed
PATCH /settings
  • Body
  • content type Modified
    • key, manageable, value, Additional properties are NOT allowed properties Removed
    • Additional properties: property Added
  • Response
  • 200 response Modified
    • data property Modified
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /settings
  • Response
  • 200 response Modified
    • data property Modified
  • Query
  • key, manageable query parameters Removed
PATCH /settings
  • Body
  • content type Modified
    • key, manageable, value, Additional properties are NOT allowed properties Removed
    • Additional properties: property Added
  • Response
  • 200 response Modified
    • data property Modified
44 structure changes including:
44 Modifications
Modified 44 Breaking
DELETE /fetch-configurations/{id}
  • Header
  • Accept-Language header Removed
DELETE /lead-segments/{id}
  • Header
  • Accept-Language header Removed
DELETE /subject-groups/{id}
  • Response
  • 404 response Added
DELETE /subjects/{id}
  • Response
  • 404 response Added
GET /employees/{id}/external-calendar-events
  • Header
  • Accept-Language header Removed
GET /employees/{id}/favorite-agents
  • Header
  • Accept-Language header Removed
GET /employees/{id}/office-coverage-regions
  • Header
  • Accept-Language header Removed
GET /employees/{id}/office-subject-coverage-regions
  • Header
  • Accept-Language header Removed
GET /fetch-configurations
  • Header
  • Accept-Language header Removed
GET /fetch-configurations/{id}
  • Header
  • Accept-Language header Removed
GET /lead-segments
  • Header
  • Accept-Language header Removed
GET /lead-segments/{id}
  • Header
  • Accept-Language header Removed
GET /lead-segments/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
GET /listings/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
GET /offices/{id}/expertises
  • Header
  • Accept-Language header Removed
GET /offices/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
GET /offices/{id}/subject-scheduling-settings
  • Header
  • Accept-Language header Removed
GET /regions
  • Header
  • Accept-Language header Removed
GET /schedulable/meeting-types
  • Header
  • Accept-Language header Removed
GET /settings
  • Header
  • Accept-Language header Removed
GET /static-translation-overrides
  • Header
  • Accept-Language header Removed
GET /static-translations/{language}
  • Header
  • Accept-Language header Removed
GET /subject-groups/{id}
  • Response
  • 404 response Added
GET /subjects/{id}
  • Response
  • 404 response Added
GET /subjects/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
PATCH /fetch-configurations/{id}
  • Header
  • Accept-Language header Removed
PATCH /lead-segments/{id}
  • Header
  • Accept-Language header Removed
PATCH /settings
  • Header
  • Accept-Language header Removed
PATCH /static-translation-overrides
  • Header
  • Accept-Language header Removed
  • Response
  • 422 response Added
PATCH /subject-groups/{id}
  • Response
  • 404, 422 responses Added
PATCH /subjects/{id}
  • Response
  • 404, 422 responses Added
POST /fetch-configurations
  • Header
  • Accept-Language header Removed
POST /lead-segments
  • Header
  • Accept-Language header Removed
POST /subject-groups
  • Response
  • 422 response Added
POST /subjects
  • Response
  • 422 response Added
PUT /employees/{id}/favorite-agents
  • Header
  • Accept-Language header Removed
PUT /employees/{id}/office-coverage-regions
  • Header
  • Accept-Language header Removed
PUT /employees/{id}/office-subject-coverage-regions
  • Header
  • Accept-Language header Removed
PUT /lead-segments/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
PUT /listings/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
PUT /offices/{id}/expertises
  • Header
  • Accept-Language header Removed
PUT /offices/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
PUT /offices/{id}/subject-scheduling-settings
  • Header
  • Accept-Language header Removed
PUT /subjects/{id}/scheduling-settings
  • Header
  • Accept-Language header Removed
1 structure change including:
1 Modification
Modified 1
PATCH /settings
  • Response
  • 422 response Added
27 structure changes including:
27 Modifications
Modified 27
DELETE /forms/{formId}/questions/{id}
  • Response
  • 404 response Added
DELETE /lead-segments/{id}
  • Response
  • 404 response Added
DELETE /listings/{id}
  • Response
  • 404 response Added
DELETE /offices/{id}
  • Response
  • 404 response Added
GET /forms/{formId}/questions
  • Response
  • 404 response Added
GET /forms/{formId}/questions/{id}
  • Response
  • 404 response Added
GET /lead-segments/{id}
  • Response
  • 404 response Added
GET /lead-segments/{id}/scheduling-settings
  • Response
  • 404 response Added
GET /listings/{id}
  • Response
  • 404 response Added
GET /listings/{id}/scheduling-settings
  • Response
  • 404 response Added
GET /offices/{id}
  • Response
  • 404 response Added
GET /offices/{id}/expertises
  • Response
  • 404 response Added
GET /offices/{id}/scheduling-settings
  • Response
  • 404 response Added
GET /offices/{id}/subject-scheduling-settings
  • Response
  • 404 response Added
PATCH /forms/{formId}/questions/{id}
  • Response
  • 404, 422 responses Added
PATCH /lead-segments/{id}
  • Response
  • 404, 422 responses Added
PATCH /listings/{id}
  • Response
  • 404, 422 responses Added
PATCH /offices/{id}
  • Response
  • 404, 422 responses Added
POST /forms/{formId}/questions
  • Response
  • 404, 422 responses Added
POST /lead-segments
  • Response
  • 422 response Added
POST /listings
  • Response
  • 422 response Added
POST /offices
  • Response
  • 422 response Added
PUT /lead-segments/{id}/scheduling-settings
  • Response
  • 404, 422 responses Added
PUT /listings/{id}/scheduling-settings
  • Response
  • 404, 422 responses Added
PUT /offices/{id}/expertises
  • Response
  • 404, 422 responses Added
PUT /offices/{id}/scheduling-settings
  • Response
  • 404, 422 responses Added
PUT /offices/{id}/subject-scheduling-settings
  • Response
  • 404, 422 responses Added
25 structure changes including:
25 Modifications
Modified 25
DELETE /forms/{id}
  • Response
  • 404 response Added
GET /appointments
  • Response
  • 200 response Modified
    • data property Modified
GET /appointments/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{formId}/questions
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • data property Modified
GET /forms/{id}
  • Response
  • 404 response Added
GET /schedulable/subjects
  • Response
  • 200 response Modified
    • data property Modified
GET /subjects
  • Response
  • 200 response Modified
    • data property Modified
GET /subjects/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /appointments/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /forms/{formId}/questions/{id}
  • Response
  • 200 response Modified
    • data property Modified
PATCH /forms/{id}
  • Response
  • 404, 422 responses Added
PATCH /subjects/{id}
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments
  • Response
  • 201 response Modified
    • data property Modified
POST /appointments/_actions/invite
  • Response
  • 201 response Modified
    • data property Modified
POST /appointments/{id}/_actions/accept
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/cancel
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/complete
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reassign
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reopen
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/request-reschedule
  • Response
  • 200 response Modified
    • data property Modified
POST /appointments/{id}/_actions/reschedule
  • Response
  • 200 response Modified
    • data property Modified
POST /forms
  • Response
  • 422 response Added
POST /forms/{formId}/questions
  • Response
  • 201 response Modified
    • data property Modified
POST /subjects
  • Response
  • 201 response Modified
    • data property Modified
4 structure changes including:
4 Modifications
Modified 4
DELETE /fetch-configurations/{id}
  • Response
  • 404 response Added
GET /fetch-configurations/{id}
  • Response
  • 404 response Added
PATCH /fetch-configurations/{id}
  • Response
  • 404, 422 responses Added
POST /fetch-configurations
  • Response
  • 422 response Added
17 structure changes including:
6 Breaking changes
2 Additions
9 Modifications
6 Removals
Modified 9
DELETE /employees/{id}
  • Response
  • 404 response Added
GET /employees/{id}
  • Response
  • 404 response Added
GET /employees/{id}/external-calendar-events
  • Response
  • 404 response Added
GET /employees/{id}/favorite-agents
  • Response
  • 404 response Added
GET /employees/{id}/office-coverage-regions
  • Response
  • 404 response Added
PATCH /employees/{id}
  • Body
  • content type Modified
    • email property Modified
  • Response
  • 404, 422 responses Added
POST /employees
  • Response
  • 422 response Added
PUT /employees/{id}/favorite-agents
  • Response
  • 404, 422 responses Added
PUT /employees/{id}/office-coverage-regions
  • Response
  • 404, 422 responses Added
Removed 6 Breaking
POST /scim/Users
PATCH /scim/Users/{id}
GET /scim/Users/{id}
GET /scim/Users
GET /scim/Schemas
DELETE /scim/Users/{id}
Added 2
PUT /employees/{id}/office-subject-coverage-regions
GET /employees/{id}/office-subject-coverage-regions