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

September 1, 2026

Meter Counter Entity

New New ma_lo_id attribute added to the meter_counter entity, carrying the Marktlokation ID of a register

August 31, 2026

Blueprint Manifest API

Breaking POST /v2/blueprint-manifest/jobs/{job_id}:continue no longer accepts the resources_to_ignore and sync_notes request fields; the request body now takes the same installation options as the install endpoints

Changed Blueprint installations can now ask for a fresh authentication: jobs report a new REAUTH_REQUIRED status wherever jobs and manifests are read, and POST /v3/blueprint-manifest/blueprint:install accepts a new optional session_credentials field

Changed The language request field of POST /v1/blueprint-manifest/jobs/{job_id}:exportManifest is no longer restricted to de and en

Environments API

Breaking Environment values are no longer text-only: the type of an environment accepts the new Text, Number, Boolean, Map, and JSON values, and its value is no longer always a string but takes the shape matching the type — affecting POST /v1/environments and PUT /v1/environments/{key} as well as everywhere environments are read

Changed PUT /v1/environments/{key} can now respond with 409 when the environment conflicts with the current state

August 28, 2026

App API

Changed App hooks can now run yearly: the intervals of a component's hook configuration accept the new P1Y value, accepted on POST/PATCH /v1/app-configurations/{appId}/versions/{version}/components and returned wherever apps and app configurations are read

Automation API

Changed Automation flows can now be triggered by relation changes: trigger operation types accept the new relationsAdded, relationsRemoved, relationsDeleted, relationsSoftDeleted, and relationsRestored values on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id}, and executions report them in trigger_event.operation_type

Changed Automation actions can now wait for a journey submission through new optional config.journey_id and config.wait_for_journey_submission fields, accepted when creating or updating a flow and returned wherever flows and executions are read; a waiting execution additionally reports a workflow_wait_context

Changed Executions started from a workflow now report who triggered it through a new optional workflow_context.trigger_user_id field, accepted on POST /v1/automation/executions and returned wherever executions are read

Billing API

Changed Pricing configuration history entries now report the installment amount through a new optional installment_amount field, returned by GET /v1/billing/billing_accounts/{id}/configuration_history, GET /v1/billing/billing_accounts/{id}/pricing_information, GET /v1/billing/contracts/{id}/configuration_history, and GET /v1/billing/contracts/{id}/pricing_information

Entity API

Breaking The variant_overridable field of schema attributes and capabilities was removed and replaced by a new optional overridable_attribute field — affecting the schema, attribute, and capability endpoints in v1 and v2, in both requests and responses

Workflows Execution API

Changed Workflow tasks can now be set to wait for a journey submission through new optional automation_config.journey_id, automation_config.wait_for_journey_submission, and automation_config.journey_execution fields, accepted on POST /v2/flows/executions, POST /v2/flows/executions/{execution_id}/tasks, and PATCH /v2/flows/executions/{execution_id}/tasks/{task_id}, and returned wherever executions and tasks are read

Changed Workflow steps and tasks report a new WAITING_FOR_JOURNEY_SUBMISSION status while they wait, returned by all execution, step, and task endpoints and accepted when creating or updating a step or task

August 27, 2026

App API

Changed App versions can now carry release notes through a new optional changelog field on PATCH /v1/app-configurations/{appId}/versions/{version}, and POST /v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion} accepts an optional request body for setting them while cloning

Entity API

Deprecated POST /v1/entity/schemas/{slug}/freeze and POST /v1/entity/schemas/{slug}/unfreeze are deprecated and will be removed in a future version

Deprecated The latest query parameter of the schema read and list endpoints is deprecated, as are the frozen, latest, and frozen_version fields of schema responses

Permissions API

Breaking Grant conditions accept a new optional attributes list for applying a condition to several attributes at once; a condition's values must now contain at least one entry

Changed Grant conditions gained two new types, NotEqualsCondition and NotEqualsCurrentUserCondition, for granting access when a value does not match — accepted on POST /v1/permissions/roles and PUT /v1/permissions/roles/{roleId} and returned wherever roles and grants are read

Targeting API

New New GET /v1/campaign/{campaign_id}/email-stats endpoint added for reading the email delivery statistics of a campaign, reporting how many recipients unsubscribed, opened, and clicked, together with the total number of opens and clicks

Changed Campaign recipients now report how their email was delivered through new optional email_status, email_status_updated_at, email_send_error, email_bounce_type, email_bounce_subtype, email_bounce_reason, email_complaint_type, email_unsubscribed_at, and message_entity_id fields, returned wherever recipients are read; GET /v1/campaign/{campaign_id}/recipients additionally accepts an email_status query parameter for filtering by it

Changed Campaign recipients also report how they engaged with the email through new optional email_open_count, email_first_opened_at, email_last_opened_at, email_click_count, email_first_clicked_at, and email_clicked_links fields

Partner Entity

Changed The partner entity now carries a workflows overview, reporting the workflows running on a partner together with their status, progress, phases, and current task

Event: Customer Request Submitted

Changed The event now also carries the meter of a ticket and its counters — new optional meter and meter_counters nodes, so consumers can resolve counter identifiers such as external_id from the event itself; both are absent for customer requests created from a journey

August 26, 2026

App API

Deprecated The secrets field of app functions is deprecated and will be removed in a future version

New New POST /v1/app/{appId}/options/resolve endpoint added for resolving the configured option values of an app

Changed App event search (POST /v1/app-configurations/{appId}/events) now accepts an optional filters.search term for searching events and an optional pagination.before cursor for paging backwards; both are echoed back in the query of the response

Changed Apps can now be configured through options: a new optional options list accepted on PATCH /v1/app-configurations/{appId}/versions/{version} and returned wherever apps and app configurations are read, where every returned option reports whether it is configured, lifted, sensitive, and when its value was last changed (value_updated_at); components declare through a new optional uses_options flag that they read those options, and accept options.sensitive on POST/PATCH /v1/app-configurations/{appId}/versions/{version}/components

Configuration Hub API

New New endpoints added for the health of an organization's configuration: GET /v1/configs/health for reading the current health, POST /v1/configs/health:scan for starting a new scan, POST /v1/configs/health:cleanup for cleaning up what a scan reported, and POST /v1/configs/health:coverage-request for requesting coverage of a configuration that is not checked yet

Entity API

Changed POST /v1/entity:graph now accepts an optional filter per graph node, for narrowing which entities that node matches

Integration Toolkit API

New New GET /v1/entities/{entityId}/sync-status endpoint added for reading how an entity is synced with the connected external system — each reported sync state carries an optional last_operation and last_synced_at, plus optional readings_last_event_id, readings_last_operation, and readings_last_synced_at for meter readings

New New POST /v1/erp/updates/direct_simulation endpoint added for simulating a direct update payload

Changed Use cases can now be configured for direct updates through a new optional configuration.direct field, and configuration.entities[].fields is no longer required — accepted when creating or updating a use case or an integration, returned wherever use cases are read, and also accepted by POST /v1/erp/updates/mapping_simulation and POST /v2/erp/updates/mapping_simulation

Changed POST /v3/erp/updates/events now accepts an optional correlation_id per event

Journey API

Action needed The values of validationRules may now also be arrays where only single values were returned before, so consumers reading a journey configuration must be prepared for both shapes

New New optional settings.authGate field added to journey configurations, controlling the authentication a journey requires — accepted when creating and updating a journey configuration in v1 and v2, and returned wherever the journey configuration is read

Notification API

Changed POST /v1/notification/notifications now accepts an optional template_id for creating a notification from a notification template, and an optional skip_user_resolution for delivering to the given recipients without resolving them to users first

Workflows Execution API

Breaking agent_execution and agent_execution_id on a workflow task may now be null where an object and a string were previously returned — affecting all flow execution and task responses

New New optional loop_iterations field added to workflow tasks, reporting how often a looping task ran; tasks and phases additionally report an optional analytics.skipped_at when they were skipped, and executions an optional analytics.started_by_org_id

August 25, 2026

Blueprint API

New New POST /v2/blueprint-manifest/jobs/{job_id}:retry endpoint added for retrying a blueprint job that did not finish

Changed Job progress now reports why an individual resource failed through new optional error_code and error_data fields on resource_progress — returned by GET /v2/blueprint-manifest/jobs, GET /v2/blueprint-manifest/jobs/{job_id}, the job cancel and continue endpoints, and the bulk-install target endpoints in v3

August 24, 2026

Message API

Changed Message and thread searches can now be narrowed to a view or to user groups through new optional view and user_groups fields on POST /v1/message/messages:search, POST /v1/message/threads:searchIds, POST /v2/message/threads:search, and POST /v1/message/unread:counts (which takes the view per scope as scopes.view_id); the search term q is no longer required on the message and thread search endpoints

August 21, 2026

Integration Toolkit API

Breaking Use case configuration no longer supports constants, lookups, params_mapping, required_params, file_source, fan_out.split_expression, upload.external_id, and upload.success_when — these fields are no longer accepted when creating or updating a use case or an integration, and are no longer returned by the use case, integration, and use case history endpoints

Changed Request steps of a use case gained two new optional fields: body_jsonata for building the request body with a JSONata expression, and enabled for switching a single step off; file uploads additionally accept an optional upload.max_total_bytes limit

Changed POST /v2/erp/imports now accepts an optional import_id to continue working on an existing import, answers with 200 in that case, and can answer with 404 or 409 when the referenced import cannot be used

Message API

New New POST /v1/message/unread:counts endpoint added for retrieving the number of unread messages