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

August 21, 2026

Workflows API

Changed Journey tasks can now pass parameters into the journey they open through a new optional context_parameters field โ€” available on the regular, ECP, and installer journey configuration of a task, accepted on POST/PUT /v1/workflows/definitions and POST/PUT /v2/flows/templates, and returned wherever workflow definitions, flow templates, and running workflow executions and tasks are read; PATCH /v2/flows/executions/{execution_id}/tasks/{task_id} also accepts it for the ECP and installer journey of a running task

August 20, 2026

Access Token API

Changed Access tokens now report when they expire through a new optional expires_at field, returned by GET /v1/access-tokens, POST /v1/access-tokens, and DELETE /v1/access-tokens/{id}

Billing API

Changed Configuration history entries are now one of several typed rows distinguished by change_type โ€” an installment amount change or a contract pricing change โ€” instead of a single flat shape; the fields that were previously always present (changed_at, created_at, entity_id, entity_type, event_id, new_value, org_id, schema_version, source) and the optional context, effective_at, previous_value, source_label, source_reference, and source_system fields are no longer part of the common row, so consumers must read them from the specific row type โ€” affecting GET /v1/billing/billing_accounts/{id}/configuration_history, GET /v1/billing/contracts/{id}/configuration_history, and the pricing information endpoints

Changed Contract pricing changes are now tracked in the configuration history: change_type accepts and returns the new contract_pricing_changed value, and a new optional history_change_types query parameter lets several change types be requested at once on all four configuration history and pricing information endpoints

Changed Pricing information (GET /v1/billing/contracts/{id}/pricing_information and GET /v1/billing/billing_accounts/{id}/pricing_information) now returns the full base_prices and working_prices lists of a contract, reports a tariff_type for each base and working price, and accepts a new optional include_history query parameter for returning the configuration history along with it

Journey Config API

New New optional stepperType field added to journey steps, controlling how a step is presented in the journey stepper โ€” accepted when creating and updating a journey configuration in v1 and v2, and returned wherever the journey configuration is read

Event: Customer Request Submitted

Breaking The event is now triggered from an automation instead of an entity operation โ€” the operation, activity_id, activity_type, and trigger_entity fields were removed, and _event_source and _trigger_source_type are now always automation

Changed ticket, event_attachments, _trigger_source_type, and _trigger_source are now always present; event_attachments is always sent but may be empty when the request carries no files, and _trigger_source identifies the automation execution and action that triggered the request

August 19, 2026

App API

Breaking The sandbox custom action type was removed โ€” configuration.type no longer accepts sandbox on POST/PATCH /v1/app-configurations/{appId}/versions/{version}/components and it is no longer returned on the app, app-configuration, and public component read endpoints

Action needed App components can now authenticate with basic auth โ€” configuration.auth_type accepts and returns the new basic value, so consumers must be prepared for this additional value

New New optional query request parameter added to the app proxy endpoints (GET/POST/PUT/PATCH/DELETE /v1/public/app/{appId}/proxy/{proxyName}/{path}) for passing a query string on to the proxied request

Changed Apps can now declare functions โ€” a new optional list accepted on PATCH /v1/app-configurations/{appId}/versions/{version} and returned wherever apps and app configurations are read, together with a new function custom action type that lets a component reference one of those functions; APP_FUNCTION is accepted as a componentType filter on GET /v1/app and as an event source on POST /v1/app-events and POST /v1/app-configurations/{appId}/events

Integration Toolkit API

New New endpoints added for managing the documentation of an integration: GET /v1/integrations/{integrationId}/documentation for listing documents, and GET/PUT/DELETE /v1/integrations/{integrationId}/documentation/{docId} for reading, storing, and removing a single document

New New DELETE /v2/erp/imports/{importId} endpoint added for deleting an import

Meter Counter Entity

Breaking The megawatt units of the meter_counter unit attribute were corrected from mw and mWh to MW and MWh โ€” the old lowercase values are no longer accepted

August 18, 2026

Configuration Hub API

New New POST /v1/configs/sync-jobs/{id}/cancel endpoint added for cancelling a running configuration sync job

Workflows Execution API

New New optional match_normalizations field added to workflow task conditions, reporting the normalizations applied when a condition value is matched โ€” returned by all flow execution and task endpoints

Validation Rules API

New New ComparisonRuleType rule type added for validating a value against another value โ€” accepted on POST /v1/validation-rules and PATCH /v1/validation-rules/{ruleId} and returned wherever rules are read

New New optional contexts field added to validation rules, limiting the contexts a rule applies in โ€” accepted when creating and patching a rule and returned by the rule list, read, and used-by endpoints

Meter Counter Entity

New New digits and decimals attributes added to the meter_counter entity, describing the register size of a meter counter

August 17, 2026

Dashboard API

New New optional version field added to dashboards, reporting which dashboard format a dashboard uses โ€” accepted on POST /v1/dashboard/dashboards and PUT /v1/dashboard/dashboards/{id}, and returned by the dashboard list, read, create, update, patch, and delete endpoints

August 15, 2026

Entity API

New New optional ui_config.widget_visibility setting added to entity schemas for controlling which widgets are shown โ€” accepted on PUT /v1/entity/schemas/{slug} and returned by the schema read, list, versions, freeze, and unfreeze endpoints

Changed Schema capabilities can now be configured further: a new optional variant_overridable flag controls whether a capability may be overridden per variant, and capability UI hooks accept new optional default_visible and pricing_tier_setting settings โ€” accepted on POST /v1/entity/schemas/capabilities, PUT /v1/entity/schemas/capabilities/{composite_id}, and PUT /v1/entity/schemas/{slug}, and returned wherever schemas and capabilities are read

August 14, 2026

AI Agents API

New New GET /v1/executions/{execution_id}/feedback endpoint added for reading the feedback recorded for an agent execution, and PUT /v1/executions/{execution_id}/feedback for submitting it

Blueprint API

New New optional active_restore_job_id and active_restore_started_at fields added to blueprints, reporting a restore that is currently running โ€” accepted on POST /v2/blueprint-manifest/blueprints and PUT /v2/blueprint-manifest/blueprints/{blueprint_id}, and returned by the blueprint list, read, create, update, and delete endpoints

Changed Restore results can now report that a resource was kept because another resource depends on it: a new dependency_protected value for reason together with a new optional protected_by field, returned by GET /v2/blueprint-manifest/jobs, GET /v2/blueprint-manifest/jobs/{job_id}, POST /v2/blueprint-manifest/jobs/{job_id}:cancel, and GET /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/restore-preview

Design Builder API

Changed DELETE /v1/designs/{designId} can now answer with 409 when the design cannot be deleted

File API

New New GET /v1/files/{id}/summary/feedback endpoint added for reading the feedback given on a file summary, and PUT /v1/files/{id}/summary/feedback for submitting it; GET /v1/files/{id}/summary now reports an optional feedback_available flag

New New optional file_summary_execution_id field added to file responses, identifying the summary generation run of a file โ€” returned by POST /v1/files, POST /v2/files, GET/DELETE /v2/files/{id}, and GET /v1/entity/{id}/collections/{collectionSlug}/files

Integration Toolkit API

New New POST /v2/erp/imports/{importId}:validate endpoint added for validating an import before executing it, and POST /v2/erp/imports/{importId}:suggest-use-cases for suggesting matching use cases โ€” the suggestion response reports file_columns once for the whole import rather than per suggestion, and every suggestion carries the entity_types it would create

Changed POST /v2/erp/imports no longer accepts integration_id and use_case_slug โ€” the import determines its use case itself

Changed POST /v2/erp/imports/{importId}:execute now accepts an optional request body and answers with 202 instead of 200, or with 422 when the import cannot be executed; POST /v2/erp/imports answers with 201 instead of 202 and accepts a new optional include_preview field for returning a preview of the import along with it

Changed Import error reporting changed: error.type was replaced by a required error.code, integration_id is no longer guaranteed, and a new optional validation.issues list reports individual validation problems โ€” each issue names the affected columns as objects with a required name and an optional entity, may point at a specific row, and no longer always carries a message โ€” affecting GET /v2/erp/imports, GET /v2/erp/imports/{importId}, and the validate, execute, and abort endpoints

Changed Use case configuration gained a set of new optional fields โ€” direction, constants, lookups, fan_out, file_source, upload, params_mapping, required_params, ack_tracking, and event_filter โ€” response is no longer required, request steps now also allow the PUT and PATCH methods, and a new file_proxy delivery type was added for forwarding files to an external system; use cases additionally report an optional changed_by, and GET /v1/integrations/{integrationId}/outbound-status reports an optional file_proxy status

Changed Mapping simulation (POST /v1/erp/updates/mapping_simulation and POST /v2/erp/updates/mapping_simulation) now always reports a mode for each entity update and meter reading update, and adds optional pricing, prune_scope_updates, and meter_readings_prune_scope_updates details

Query API

New New POST /v2/query/autocomplete:search endpoint added for autocompleting values while composing a query

New New GET /v2/query/chart-templates endpoint added for listing the available chart templates, and POST /v2/query/chart-templates/{template_id}:resolve for resolving a template into a runnable query

August 13, 2026

Automation API

New New AssignEntityAction automation action added for assigning an entity from a flow โ€” it can be configured on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id}, and is returned wherever actions are read (the flow read, list, search, and batch-get endpoints, the execution endpoints, and POST /v1/automation/public/executions:resume)

August 12, 2026

Blueprint API

Action needed Blueprints now support a new insight resource type โ€” it is accepted in type and hard_dependencies when creating or updating blueprint resources (POST/PUT /v2/blueprint-manifest/blueprints, the resource create, update, and bulk endpoints, and POST /v1/blueprint-manifest/jobs:createExport) and is returned wherever resource and job types are reported, so consumers must be prepared for this additional value

Calendar API

Changed Calendar events now always return an is_draft flag indicating whether the event is still a draft โ€” added to GET /v1/calendar/events, POST /v1/calendar/events, and GET/PATCH /v1/calendar/events/{event_id}

Changed An event can now be cancelled through the new optional is_cancelled field on PATCH /v1/calendar/events/{event_id}

Deduplication API

Breaking POST /v1/deduplicate now returns an object with a deduplicatedEntities list instead of a bare array

New New POST /v1/detect-duplicates endpoint added for finding duplicates of an entity, and POST /v1/duplicates/dismiss for dismissing a reported duplicate

New New endpoints added for managing the uniqueness criteria that decide when two entities count as duplicates: GET/POST /v1/uniqueness-criteria for listing and creating them, and GET/PUT/DELETE /v1/uniqueness-criteria/{schema} for reading, replacing, and removing the criteria of a single schema

Email Settings API

New New optional skip_test query parameter added to POST /v2/smtp/connections and PUT /v2/smtp/connections/{connectionId} for saving a connection without testing it first

Changed smtp_port is now a string instead of an integer in all SMTP connection responses (GET/POST /v2/smtp/connections and GET/PUT /v2/smtp/connections/{connectionId}); requests accept both a string and an integer