Skip to main content

API Changelog

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

Showing changes to all APIs. This includes APIs for specific platform features, which are not part of the core APIs integrations are built on and change more often. Show core APIs only

June 30, 2026

Blueprint API

Deprecated The Terraform-based v2 install, validate, export, and patch endpoints were deprecated in favor of the V3 install engine (POST /v2/blueprint-manifest/blueprint:install, POST .../blueprints/{blueprint_id}/validate, POST .../blueprints/{blueprint_id}:export, and the .../blueprints/{blueprint_id}/patches family)

New New bulk-install endpoints added for installing one blueprint into many organizations in a single request: POST /v3/blueprint-manifest/bulk-installs, GET /v3/blueprint-manifest/bulk-installs/{bulk_job_id}, GET .../bulk-installs/{bulk_job_id}/targets, and POST .../bulk-installs/{bulk_job_id}/targets/{destination_org_id}:retry for retrying an individual failed target

Changed POST /v3/blueprint-manifest/blueprint:install now accepts an optional auto_apply flag; when true, the install is applied automatically after the plan and snapshot steps instead of waiting for a separate :continue call

Customer Portal API

Breaking The export request now requires a JSON body specifying the entity schema and ordered columns to export (with optional search filters); the language query parameter was removed in favor of a body field

New New endpoints added to request an asynchronous CSV export of a portal user's contracts, delivery points, and meters, and to poll the export job for a download link once it is ready

Event Catalog API

New New optional success_criteria field added to event configurations (returned by GET /v1/events and GET /v1/events/{event_name}, settable via PATCH /v1/events/{event_name}), listing the entity attributes an organization considers required for an event to be complete

Webhooks API

Changed Event replay can now re-run the JSONata transform: POST /v1/webhooks/configs/{configId}/events/{eventId}/replay and .../events/replay-batch accept an optional reapply_transform flag that reconstructs the original pre-transform input and re-runs the full delivery pipeline (default false, which resends the post-transform payload as-is)

Changed Webhook event responses now include original_payload (the raw pre-transform input, when available), can_reapply_transform, and can_reapply_transform_reason; single-event replay can now return 422 when the original input cannot be reconstructed

June 29, 2026

Message API

New New optional updated_by field added to message and thread responses, recording the user who last edited the message

Changed PUT /v1/message/messages can now return 409 Conflict when a draft has been edited by someone else since it was loaded, including the current server version of the message so clients can reload and retry

Portal User Entity

New New read-only first_login and last_login date-time attributes added, recording when a portal user first and most recently signed in

June 26, 2026

Audit Log API

Changed POST /v1/logs now accepts resource_id, resource_type, and action filters for narrowing audit-log searches to the resource an event targets and its semantic action name (e.g. blueprint.resource_added); the same three fields are now returned on each log record

Customer Portal API

New New endpoints added to read and update a portal's mobile app configuration (GET/PUT /v1/portal/mobile-config), covering app branding, iOS and Android settings, and over-the-air (OTA) update settings

New New POST /v2/portal/entity/{slug} and PATCH /v2/portal/entity/{slug}/{id} endpoints added for creating and updating entities in the portal context

Integration Toolkit API

New New optional prevent_indirect_serving field added to FileProxy use case configuration; when true, files too large to be served directly in the proxy response are rejected instead of being served via a temporary S3 redirect, so files never transit epilot's temporary storage

June 25, 2026

Entity API

New New optional q query parameter added to GET /v1/entity/views for free-text searching saved views by name

Calendar API

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

Snapshot API

New 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

Integration Toolkit API

New 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)

Changed 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

June 24, 2026

File API

Breaking The summary_status field was removed from file response objects — read summary state from the new summary endpoints instead

Changed 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

Workflows Execution API

New 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

Event: Location Move Requested

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

June 22, 2026

Email Template API

Changed 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

SSO API

Changed 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

June 19, 2026

Dashboard API

New 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 New PATCH /v1/dashboard/dashboards/{id} endpoint added for partially updating a dashboard

Changed 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

Changed Dashboard tiles can now reference a saved insight via insight_id, in addition to the existing inline visualisation

Workflows Execution API

New 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)

June 18, 2026

Email Settings API

Changed 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

June 17, 2026

ERP Integration API

Changed 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

Targeting API

Breaking automation_status query parameter on GET /v1/campaign/{campaign_id}/recipients changed from a single-value enum to a repeatable array parameter

Changed 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

June 16, 2026

Blueprint API

Breaking 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

New 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

Snapshot API

Breaking 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

New New POST /v1/snapshots:capture-org endpoint added for asynchronously snapshotting the caller's entire organization

Changed POST /v1/snapshots/{id}:restore now accepts an optional exclude_target_ids array (target IDs the caller wants left untouched during restore)