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

October 5, 2026

Journey Config API

New New POST /v1/journey/configuration/{id}/external-values endpoint was added for a journey configuration's external values

Workflows Definition API

Deprecated tasks[].loop_config on flow templates is now deprecated in favour of tasks[].loops

Changed Flow templates now support advanced loops: tasks can define loops through a new optional tasks[].loops field and edges can belong to a loop through a new optional edges[].loop_id field. Both are accepted on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId}, which also take a new optional client_supports_adv_loops query parameter, and both are returned wherever flow templates are read

October 2, 2026

Blueprint Manifest API

Action needed Bulk installs and their targets can now wait for review: status returns the new REVIEW_REQUIRED value from the /v3/blueprint-manifest/bulk-installs endpoints, so consumers must be prepared for this additional status. Bulk installs also report a new counts.review_required count, and jobs and targets link to their merge plan through new optional merge_plan_id fields

New New merge plan endpoints were added for reviewing and resolving conflicts before a blueprint is installed: GET /v3/blueprint-manifest/merge-plans/{merge_plan_id} with its resources and resources/{resource_key} sub-resources, PUT /v3/blueprint-manifest/merge-plans/{merge_plan_id}/resolutions for setting resolutions, and the :apply, :discard, :replan, :preview-revert, and :revert actions

Changed Blueprint deployments now report their merge plan and whether they can be reverted, through new optional deployments[].merge_plan_id, merge_plan_state, merge_snapshot_id, revert_until, and snapshot_restore_available fields

Journey Config API

New Journey environment variables now support typed values: type on GET /v1/journey/environment-variables can return the new Text, Number, Boolean, List<Text>, List<Number>, and List<Boolean> values, with value holding a matching scalar or list โ€” so consumers must be prepared for these additional types

Changed GET /v1/journey/configuration/{id}/environment now returns the resolved variables together with any variableErrors, and can now also be called with portal authentication

Organization API

New New GET /v2/organization/announcements/active and POST /v2/organization/announcements/{announcement_id}/acknowledge endpoints were added for reading active announcements and acknowledging them

Submission API

Breaking GET /v1/submission/nonce/{nonce_id} now responds with an object containing a required exists flag and an optional nonce instead of returning the nonce directly

October 1, 2026

Blueprint Manifest API

Action needed Blueprint jobs can now fail with the new workflow_quota_reached error code when installing would exceed the organization's workflow limit, with new optional data.current, data.max_allowed, and data.planned fields describing the quota โ€” returned wherever blueprint job errors are read, so consumers must be prepared for this additional error code

September 30, 2026

Blueprint Manifest API

Action needed Email signatures and shared inboxes can now be included in blueprints through the new email_signature and shared_inbox resource types โ€” accepted when adding blueprint resources and creating exports, and returned wherever blueprint resources, manifests, and jobs are read, so consumers must be prepared for these additional resource types

Email Settings API

Changed DELETE /v1/email-settings now responds with 204 and no content instead of 200

Integration Address API

New New GET /v1/integration/location/{country}/enrich endpoint was added for enriching location data for a country

Permissions API

Changed Roles can now be scoped to a portal through a new optional portal_id field โ€” accepted on POST /v1/permissions/roles and PUT /v1/permissions/roles/{roleId} and returned wherever roles are read

September 29, 2026

Entity API

Breaking The zipcode and zipcode_town values of conditions[].format on entity schemas were renamed to postal_code and postal_code_city โ€” affecting PUT /v1/entity/schemas/{slug} and everywhere entity schemas are read

Integration Toolkit API

Breaking validation.entity_details_truncated was removed from import responses on all /v2/erp/imports endpoints

New New POST /v1/integrations/{integrationId}/outbound/mapping-simulation endpoint was added for simulating outbound mappings

New Dead-lettered outbound messages can now be redriven with the current mapping re-applied through a new optional reapply_mapping field on POST /v1/integrations/{integrationId}/outbound/messages/dlq/redrive โ€” redrive results can now return the new mapping_failed status together with a mapping_error, so consumers must be prepared for this additional status

New New GET /v2/erp/imports/{importId}/download and GET /v2/erp/imports/{importId}/preview endpoints were added for downloading and previewing an import

Changed POST /v2/integrations/{integrationId}/monitoring/stats can now filter by correlation through new optional correlation_id and correlation_ids fields, and group results by the new correlation_id value of group_by

September 28, 2026

Workflows Definition API

Changed Flow templates can now define how contexts are handled through a new optional context_settings field, and automation tasks can attach their output to contexts through a new optional tasks[].automation_config.output_context.attach_to_contexts field โ€” both accepted on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and returned wherever flow templates are read

Workflows Execution API

Changed Flow executions can now be kept in the background: new optional visibility and visible_on fields control where an execution is shown โ€” accepted on PATCH /v2/flows/executions/{execution_id} and returned wherever flow executions are read โ€” and POST /v2/flows/executions:search accepts a new optional include_background flag for including background executions in the results

September 25, 2026

Entity API

New New GET /v1/entity/schemas/{slug}/head endpoint was added for reading the latest version of an entity schema

Changed PUT /v1/entity/schemas/{slug} now supports safe concurrent updates: new optional base_version and base_updated_at query parameters name the schema version the update is based on, and the endpoint can respond with 409 when the schema was changed in the meantime

Integration Toolkit API

Changed POST /v1/erp/updates/events, POST /v2/erp/updates/events, and POST /v3/erp/updates/events can now respond with 429 when too many requests are made

September 24, 2026

Workflows Execution API

Deprecated loop_config.crt_iterations and loop_config.max_iterations on phases and tasks are now deprecated and will be removed in a future version โ€” affecting everywhere flow executions, phases, and tasks are read

September 23, 2026

Integration Toolkit API

Changed Conditional entity mappings no longer take conditional.folds; the rows a conditional mapping is built from are now described by a new required conditional.from_rows instead โ€” affecting use case and integration create/update endpoints, POST /v1/erp/updates/direct_simulation, the mapping simulation endpoints, and everywhere use cases and integrations are read

Changed Import jobs can now fail with the new CHUNK_TOO_LARGE error code, and validation reports the new issue codes CONDITIONAL_TARGET_MODE_UNSUPPORTED and GROUPING_KEY_IS_SORT_COLUMN, replacing GROUPING_KEY_IS_FOLD_COLUMN โ€” returned by all /v2/erp/imports endpoints

Journey Config API

Changed Journey steps can now be shown to guest users through a new optional steps[].guestVisible field โ€” accepted when creating or updating a journey configuration or revision and returned wherever journey configurations are read

September 22, 2026

Workflows Definition API

Breaking edges[].end_type was removed from flow templates: it is no longer accepted by POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and no longer returned wherever flow templates are read

Workflows Execution API

Breaking edges[].end_type was removed from flow executions: it is no longer returned wherever flow executions are read

Action needed Task conditions can now be evaluated against the main context: tasks[].conditions[].statements[].source.origin_type returns the new main_context value โ€” so consumers must be prepared for this additional value

Changed Workflow stages can now report that they were never reached: stages[].status returns the new NOT_REACHED value from POST /v2/flows/executions:portal-search and POST /v2/flows/executions:portal-search-batch โ€” so consumers must be prepared for this additional status

Changed Execution contexts now report by which task they were added, and when and by which task they were promoted or demoted, through new optional contexts[].added_by_task_id, contexts[].promoted_at, contexts[].promoted_by_task_id, and contexts[].demoted_by_task_id fields โ€” accepted on POST /v2/flows/executions and PATCH /v2/flows/executions/{execution_id} and returned wherever flow executions are read

Changed Automations can now write their result into a context through a new optional automation_config.output_context field on a task and on the trigger โ€” 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 flow executions are read

September 21, 2026

Automation API

New New POST /v1/automation/journey-context:usages endpoint was added for reading where a journey context is used

Changed Automations can now be executed with inputs for their actions, through a new optional action_inputs field โ€” accepted on POST /v1/automation/executions and returned wherever executions are read

Changed Action attachments can now be narrowed down by file name: new optional actions[].config.attachments[].source_filter.filename and source_filter.filename_pattern fields โ€” accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows and executions are read

Pricing API

Changed POST /v1/public/product-recommendations now reports where a recommendation came from through a new optional source field

Workflows Definition API

New New POST /v1/workflows-definition/journey-context:usages endpoint was added for reading where a journey context is used

Changed Automation tasks in a flow template can now ask for a note when they are executed, restrict which closing reasons may be picked, and have the email they send reviewed before it goes out, through new optional tasks[].automation_config.allow_execution_note, automation_config.eligible_closing_reason_ids, and automation_config.email_review fields โ€” accepted on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and returned wherever flow templates are read

Changed POST /v1/workflows/definitions can now respond with 409 when the definition conflicts with an existing one