Skip to main content

API Changelog

Breaking changes, new features, and significant updates to epilot APIs. Subscribe via RSS

2026-06-25 Calendar API

  • New DELETE /v1/calendar/sources/outlook/{calendar_id} endpoint added for disconnecting a previously connected Outlook calendar

2026-06-25 Snapshot API

  • New endpoints added to schedule recurring organization snapshots — read, create or update, and delete a per-organization snapshot schedule (GET/PUT/DELETE /v1/org-snapshot-schedule) with a cron expression, timezone, retention window, and excluded resource types

2026-06-25 Integration Toolkit API

  • New integration notification-monitoring endpoints added: GET /v2/integrations/{integrationId}/notifications/history (paginated history of fired and suppressed notifications), GET /v2/integrations/{integrationId}/notifications/status (live per-rule alert state and baseline bands), and POST /v2/integrations/{integrationId}/notifications/test (send a test notification to the calling user)
  • Integration settings now carry an optional notifications configuration object (recipients, delivery channels, alert rules, and digest schedule) on the v1 and v2 create, update, and read endpoints

2026-06-24 File API

  • AI file summaries are now managed as asynchronous jobs: new GET /v1/files/{id}/summary returns the current summary text and status, POST /v1/files/{id}/summary-jobs creates (or returns) the current summary job, and GET /v1/files/{id}/summary-jobs/current and GET /v1/files/{id}/summary-jobs/{job_id} poll job status; the summary response now exposes per-language preview_summary_de/preview_summary_en and short_summary_de/short_summary_en fields
  • The summary_status field was removed from file response objects — read summary state from the new summary endpoints instead (breaking)

2026-06-24 Workflows Execution API

  • New optional read-only error_reason field added to the schedule (DelayedSchedule/RelativeSchedule) of automation and decision tasks across flow execution responses; it is populated when scheduling the task failed (e.g. the referenced date attribute is empty or the resolved fire time is already in the past) and cleared once the task is successfully re-armed

2026-06-24 Event: Location Move Requested

  • The single meter_counter field was replaced by a meter_counters array, so moves involving multiple meter counters are now fully represented (breaking)

2026-06-22 Email Template API

  • POST /v1/email-template/templates/{id}:convertToBuilder now accepts an optional as_copy flag (with an optional name) to convert a template to the visual builder as a new copy, leaving the original template unchanged

2026-06-22 SSO API

  • POST /v1/sso/public/login responses now include an optional role_assignment object, reporting the roles assigned to the user by the SSO provider's role mapping and whether they changed during this login

2026-06-19 Dashboard API

  • New Insights resource added for managing reusable saved charts independently of dashboards: GET/POST /v1/dashboard/insights and GET/PUT/PATCH/DELETE /v1/dashboard/insights/{id}
  • New PATCH /v1/dashboard/dashboards/{id} endpoint added for partially updating a dashboard
  • Dashboards and insights now carry ownership and sharing metadata (owners, shared_with, org_access); sharing is managed via the new PATCH operations and only owners may change it
  • Dashboard tiles can now reference a saved insight via insight_id, in addition to the existing inline visualisation

2026-06-19 Workflows Execution API

  • New optional outcome field added to AI agent task responses, exposing the server-computed result of the agent execution (e.g. assigned, recommended, no_eligible_partner, missing_input)

2026-06-18 Email Settings API

  • POST /v2/outlook/mailbox/connect now accepts new optional fields: name (sender name for the mailbox), user_ids and group_ids (users and groups the mailbox is available to by default), and default_signature_id

2026-06-17 ERP Integration API

  • POST /v1/secure-proxy now returns a structured error body on 502 (a required message category plus optional code and reason), so clients can distinguish an upstream-side failure — TLS/certificate, DNS, connection refused/reset, or timeout — from an epilot-side one; successful upstream responses still pass through their original status and body unchanged

2026-06-17 Targeting API

  • automation_status query parameter on GET /v1/campaign/{campaign_id}/recipients changed from a single-value enum to a repeatable array parameter (breaking)
  • POST /v1/campaign:setup no longer requires automation_id on the email channel and accepts a new optional template_id, allowing the flow to be created from a template instead of a pre-selected automation

2026-06-16 Blueprint API

  • New GET /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/restore-preview endpoint added, returning the predicted outcome of reverting a deployment without making any changes
  • POST /v3/blueprint-manifest/blueprint-instances/{blueprint_instance_id}:restore endpoint removed; deployment restore now runs only via POST .../blueprints/{blueprint_id}/deployments/{job_id}:restore (breaking)

2026-06-16 Snapshot API

  • New POST /v1/snapshots:capture-org endpoint added for asynchronously snapshotting the caller's entire organization
  • POST /v1/snapshots/{id}:restore now accepts an optional exclude_target_ids array (target IDs the caller wants left untouched during restore)
  • The preserve_modified option was removed from POST /v1/snapshots/{id}:restore, and the related skipped arrays (and SkippedResource schema) were removed from restore and capture results on GET /v1/snapshots and GET /v1/snapshots/{id}; drift-based skipping is no longer performed during restore (breaking)

2026-06-16 User API

  • New public password-reset endpoints added: POST /v2/users/public/requestPasswordReset and POST /v2/users/public/resetPassword (unauthenticated, rate-limited), plus an authenticated POST /v2/users:sendPasswordReset for triggering a reset email for a user in the caller's organization

2026-06-15 Email Template API

  • New GET /v1/email-template/templates/{id}:references endpoint added, returning where a template is currently referenced

2026-06-15 Integration Toolkit API

  • New endpoints added for managing outbound message queues: POST /v1/integrations/{integrationId}/outbound/messages/poll, .../ack, and .../unblock, plus GET /v1/integrations/{integrationId}/outbound/messages/dlq and POST .../outbound/messages/dlq/redrive for dead-letter handling
  • Outbound use case delivery configuration was restructured into a discriminated union of WebhookDeliveryConfig and the new PollDeliveryConfig; the previous flat type, webhook_id, webhook_name, and webhook_url delivery fields were removed (breaking)

2026-06-15 Automation API

  • New optional evaluation_order (AFTER_SCHEDULE / BEFORE_SCHEDULE) and allow_failure fields added to flow condition items — evaluation_order controls how a condition combines with its schedule, and allow_failure lets execution continue past a condition block that errors

2026-06-15 Core Entities

  • The journey entity gained new relations to products, prices, and files; correspondingly, the product, price, and file entities each gained a new journeys relation

2026-06-15 Event: Meter Reading Added

  • New account field added carrying the full account entity related to the reading (company details, addresses, payment data, contacts, and related entities)

2026-06-12 Access Token API

  • New optional read_only field added when creating access tokens (POST /v1/access-tokens); a read-only token may only perform view, export, and download actions regardless of the roles it carries

2026-06-09 Calendar API

  • New endpoints added for managing calendars and events: POST /v1/calendar, PATCH/DELETE /v1/calendar/{calendar_id}, POST /v1/calendar/events, and PATCH/DELETE /v1/calendar/events/{event_id}, plus POST /v1/calendar/sources/outlook and GET /v1/calendar/sources/outlook/available for connecting Outlook calendars

2026-06-08 Workflows Execution API

  • New POST /v2/flows/executions/{execution_id}/tasks/{task_id}/reconcile-automation endpoint added for reconciling the status of a stuck automation task

2026-06-07 Event Catalog API

  • New GET /v1/events/{event_name}/versions endpoint added listing the available payload schema versions for an event, and a new optional Epilot-Event-Version header on the JSON-schema and example endpoints to request a specific version
  • New _downgrades field added to event history responses, describing how a payload was downgraded to an older schema version