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 21, 2026

Workflows Execution API

Changed The email an automation task sends can now be reviewed before it goes out: new GET /v2/flows/executions/{execution_id}/tasks/{task_id}/email-preview endpoint for previewing that email, together with a new optional automation_config.email_review field โ€” 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

Changed Automation tasks can now ask for a note when they are executed and restrict which closing reasons may be picked, through new optional automation_config.allow_execution_note and automation_config.eligible_closing_reason_ids 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 flow executions are read

Changed POST /v2/flows/executions/{execution_id}/tasks/{task_id}/automation:run now accepts an optional request body, and it and POST /v2/flows/executions/{execution_id}/tasks/{task_id}/schedule/run-now can respond with 409 when the run conflicts with the current state

September 18, 2026

Audit Log API

Changed Audit log records now carry a visibility: a new optional visibility field is accepted on POST /v1/logs for narrowing a search and returned on each record, and GET /v1/logs/{logId} accepts a matching optional visibility query parameter

Journey Config API

New Journey environment variables can now hold a list of links: type returns the new List<Link> value with a matching value shape, and GET /v1/journey/environment-variables can additionally return a map value shape โ€” so consumers reading GET /v1/journey/environment-variables and GET /v1/journey/configuration/{id}/environment must be prepared for these additional value shapes

September 17, 2026

Blueprint Manifest API

Breaking The v2 blueprint install, export, and publish endpoints were removed: POST /v2/blueprint-manifest/blueprint:install, POST /v2/blueprint-manifest/blueprints/{blueprint_id}:export, and POST /v2/blueprint-manifest/blueprints:publish

Changed The blueprint patch endpoints were removed: GET and POST /v2/blueprint-manifest/blueprints/{blueprint_id}/patches, GET /v2/blueprint-manifest/blueprints/{blueprint_id}/patches/{patch_id}, POST /v2/blueprint-manifest/blueprints/{blueprint_id}/patches:detect, POST /v2/blueprint-manifest/blueprints/{blueprint_id}/patches/{patch_id}:apply, and POST /v2/blueprint-manifest/blueprints/{blueprint_id}/patches/{patch_id}/orgs/{org_id}:retry

Changed POST /v3/blueprint-manifest/blueprints/{blueprint_id}:publish now accepts optional name, slug, and version fields for the blueprint being published

Document API

New New POST /v2/templates:validate endpoint was added for validating a document template

Email Template API

Changed The variable_parameters.language request field of POST /v1/email-template/templates:replace and POST /v1/email-template/templates:replaceAsync is no longer restricted to de and en

September 16, 2026

Entity API

Changed GET /v1/entity:autocomplete now accepts an optional from query parameter

File API

Changed GET /v1/files/public/{id}/preview now accepts an optional keep_original query parameter

Workflows Execution API

Changed Task conditions can now be evaluated against the trigger that started the workflow: tasks[].conditions[].statements[].source.origin_type returns the new trigger_source value, and tasks gained a new optional automation_config.input_context.trigger_id naming that 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

Changed Flow executions now report the triggers set up for them through a new optional configured_triggers, and the trigger that started an execution can be named through a new optional trigger.trigger_id โ€” accepted on POST /v2/flows/executions and returned wherever flow executions are read

September 15, 2026

Automation API

Action needed Automation flows can now be triggered by Event Catalog events: a new event catalog trigger shape is accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows are read, GET /v1/automation/flows accepts a new optional trigger_event_name query parameter for finding the flows a catalog event triggers, and executions report the catalog event as their trigger_event โ€” so consumers must be prepared for these additional trigger and trigger event shapes

Changed Conditions can now be evaluated against the event that started the automation: conditions[].statements[].source.originType accepts and returns the new event value

Changed Automations can now loop over the files uploaded in a journey: loops[].source_type accepts and returns the new journey-file-upload value, together with a new optional loops[].filter_tags for narrowing which files are looped over

Entity API

Breaking Schema conditions no longer carry values; which values a condition matches is now described by a new optional options instead โ€” affecting PUT /v1/entity/schemas/{slug} and everywhere schemas are read

New New optional ui_config.custom_tabs field added to entity schemas, accepted on PUT /v1/entity/schemas/{slug} and returned by the schema read, list and versions endpoints

Changed Capabilities can now declare which fields they manage through a new optional managed_fields field โ€” 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

Pricing API

Changed Line items can now carry the inputs an external fee was calculated from, through a new optional external_fees_metadata.inputs field on a line item and on its item components โ€” accepted on POST /v1/order, PUT /v1/order/{id}, POST /v1/pricing:compute, and POST /v1/public/cart:checkout

Changed POST /v1/public/integration/{integrationId}/compute-price now accepts an optional city for the address the price is computed for, and reports the inputs the computation was based on

User API

Changed The language request field of POST /v2/users/invite, POST /v2/users/invite:resendEmail, and POST /v2/users/public/signup is no longer restricted to de and en

Changed GET /v2/users/public/checkToken now reports which login methods are available through a new optional login_methods field

Workflows Definition API

Changed Task conditions can now be evaluated against the trigger that started the workflow: tasks[].conditions[].statements[].source.origin_type accepts and returns the new trigger_source value, and tasks gained a new optional automation_config.input_context.trigger_id naming that trigger โ€” accepted on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and returned wherever flow templates are read

Asset Entity

New New _purpose attribute added to the asset entity, carrying the list of purpose ids an asset is assigned to

September 14, 2026

AI Agents API

Changed Agents can now be made available on a website: availability accepts the new website value, together with a new optional domain naming the website the agent answers on โ€” both accepted on POST /v1/agents and PUT /v1/agents/{agent_id} and returned wherever agents are read, and website is also accepted by the availability query parameter of GET /v1/agents

Changed PUT /v1/agents/{agent_id} can now respond with 404 when the agent does not exist and 409 when the update conflicts with the current state

App API

Changed PATCH /v1/app/{appId} can now respond with 400 when the request cannot be processed

Blueprint Manifest API

Breaking Blueprint validation was removed: POST /v2/blueprint-manifest/blueprints/{blueprint_id}/validate was removed after deprecation, POST /v2/blueprint-manifest/blueprints/{blueprint_id}:export no longer accepts the validate request field, and the validate job type is no longer returned by GET /v2/blueprint-manifest/jobs, GET /v2/blueprint-manifest/jobs/{job_id}, and POST /v2/blueprint-manifest/jobs/{job_id}:cancel

Workflows Definition API

Changed Journey tasks can now have their journey prefilled by AI, through a new optional journey.ai_prefill field โ€” available on the regular, ECP, and installer journey configuration of a task, accepted on POST/PUT /v1/workflows/definitions, POST /v2/flows/templates, and PUT /v2/flows/templates/{flowId}, and returned wherever workflow definitions and flow templates are read

Changed Flow templates gained new optional stages for grouping their tasks into stages, portal_titles for the titles shown in the customer portal, stages[].portal_descriptions for the descriptions shown there, and edges[].end_type โ€” accepted on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and returned wherever flow templates are read

Changed Journey tasks can now set the label shown on their portal button, through a new optional journey.portal_button_label field โ€” available on the regular, ECP, and installer journey configuration of a task, accepted on POST/PUT /v1/workflows/definitions, POST /v2/flows/templates, and PUT /v2/flows/templates/{flowId}, and returned wherever workflow definitions and flow templates are read

Workflows Execution API

Changed Journey tasks can now have their journey prefilled by AI, through a new optional journey.ai_prefill field โ€” available on the regular, ECP, and installer journey configuration of a task, accepted on PATCH /v2/flows/executions/{execution_id}/tasks/{task_id} and returned wherever workflow and flow executions are read, together with a new optional journey_prefill on the task itself

Changed Flow executions gained new optional stages for grouping their tasks into stages, with each task reporting the stage it belongs to through a new optional stage_id, and a new optional edges[].end_type โ€” returned wherever flow executions are read

Changed Flow executions and their stages now report the titles and descriptions shown in the customer portal through new optional portal_titles, stages[].portal_names, and stages[].portal_descriptions fields โ€” returned wherever flow executions are read, including POST /v2/flows/executions:portal-search and POST /v2/flows/executions:portal-search-batch

Changed Journey tasks now carry the label shown on their portal button, through a new optional journey.portal_button_label field โ€” available on the regular, ECP, and installer journey configuration of a task, accepted on PATCH /v2/flows/executions/{execution_id}/tasks/{task_id} and returned wherever workflow and flow executions are read

September 11, 2026

Automation API

Changed Automation assignment actions can now pick an assignee by skill: new optional config.match_user_skills, config.required_skill_categories, and config.skill_match_mode fields โ€” accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows and executions are read

Dashboard API

New New GET /v1/dashboard/dashboards/quota endpoint added for reading the dashboard quota of an organization

Changed POST /v1/dashboard/dashboards, PATCH /v1/dashboard/dashboards/{id}, and PUT /v1/dashboard/dashboards/{id} can now respond with 403

Environments API

Changed Environments can now hold a list of values: the type of an environment accepts the new List value with a matching value shape, and the type of the entries is reported through a new optional item_type โ€” accepted on POST /v1/environments and PUT /v1/environments/{key} and returned wherever environments are read

Workflows Execution API

Changed POST /v2/flows/executions can now respond with 503 when a workflow execution cannot be started at the moment

September 10, 2026

Access Token API

New New GET /v1/access-tokens/contact-identification/.well-known/jwks.json and GET /v1/access-tokens/contact-identification/.well-known/openid-configuration endpoints added for verifying contact identification tokens

Changed Access tokens can now identify a contact: POST /v1/access-tokens accepts a new set of contact identification parameters, the new contact_identification value is returned as token_type wherever access tokens are read and accepted by the token_type query parameter of GET /v1/access-tokens, and such tokens report new optional contact_id and allowed_operations fields