API Changelog
Breaking changes, new features, and significant updates to epilot APIs. Subscribe via RSS
2026-08-28 Billing API
- Pricing configuration history entries now report the installment amount through a new optional
installment_amountfield, returned byGET /v1/billing/billing_accounts/{id}/configuration_history,GET /v1/billing/billing_accounts/{id}/pricing_information,GET /v1/billing/contracts/{id}/configuration_history, andGET /v1/billing/contracts/{id}/pricing_information
2026-08-28 Entity API
- The
variant_overridablefield of schema attributes and capabilities was removed and replaced by a new optionaloverridable_attributefield โ affecting the schema, attribute, and capability endpoints in v1 and v2, in both requests and responses (breaking)
2026-08-28 Workflows Execution API
- 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, andautomation_config.journey_executionfields, accepted onPOST /v2/flows/executions,POST /v2/flows/executions/{execution_id}/tasks, andPATCH /v2/flows/executions/{execution_id}/tasks/{task_id}, and returned wherever executions and tasks are read - Workflow steps and tasks report a new
WAITING_FOR_JOURNEY_SUBMISSIONstatus while they wait, returned by all execution, step, and task endpoints and accepted when creating or updating a step or task
2026-08-27 App API
- App versions can now carry release notes through a new optional
changelogfield onPATCH /v1/app-configurations/{appId}/versions/{version}, andPOST /v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}accepts an optional request body for setting them while cloning
2026-08-27 Entity API
POST /v1/entity/schemas/{slug}/freezeandPOST /v1/entity/schemas/{slug}/unfreezeare deprecated and will be removed in a future version- The
latestquery parameter of the schema read and list endpoints is deprecated, as are thefrozen,latest, andfrozen_versionfields of schema responses
2026-08-27 Permissions API
- Grant conditions gained two new types,
NotEqualsConditionandNotEqualsCurrentUserCondition, for granting access when a value does not match โ accepted onPOST /v1/permissions/rolesandPUT /v1/permissions/roles/{roleId}and returned wherever roles and grants are read - Grant conditions accept a new optional
attributeslist for applying a condition to several attributes at once; a condition'svaluesmust now contain at least one entry (breaking)
2026-08-27 Targeting API
- New
GET /v1/campaign/{campaign_id}/email-statsendpoint 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 - 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, andmessage_entity_idfields, returned wherever recipients are read;GET /v1/campaign/{campaign_id}/recipientsadditionally accepts anemail_statusquery parameter for filtering by it - 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, andemail_clicked_linksfields
2026-08-27 Partner Entity
- The
partnerentity now carries aworkflowsoverview, reporting the workflows running on a partner together with their status, progress, phases, and current task
2026-08-27 Event: Customer Request Submitted
- The event now also carries the meter of a ticket and its counters โ new optional
meterandmeter_countersnodes, so consumers can resolve counter identifiers such asexternal_idfrom the event itself; both are absent for customer requests created from a journey
2026-08-26 App API
- App event search (
POST /v1/app-configurations/{appId}/events) now accepts an optionalfilters.searchterm for searching events and an optionalpagination.beforecursor for paging backwards; both are echoed back in thequeryof the response - Apps can now be configured through options: a new optional
optionslist accepted onPATCH /v1/app-configurations/{appId}/versions/{version}and returned wherever apps and app configurations are read, where every returned option reports whether it isconfigured,lifted,sensitive, and when its value was last changed (value_updated_at); components declare through a new optionaluses_optionsflag that they read those options, and acceptoptions.sensitiveonPOST/PATCH /v1/app-configurations/{appId}/versions/{version}/components - New
POST /v1/app/{appId}/options/resolveendpoint added for resolving the configured option values of an app - The
secretsfield of app functions is deprecated and will be removed in a future version
2026-08-26 Configuration Hub API
- New endpoints added for the health of an organization's configuration:
GET /v1/configs/healthfor reading the current health,POST /v1/configs/health:scanfor starting a new scan,POST /v1/configs/health:cleanupfor cleaning up what a scan reported, andPOST /v1/configs/health:coverage-requestfor requesting coverage of a configuration that is not checked yet
2026-08-26 Entity API
POST /v1/entity:graphnow accepts an optionalfilterper graph node, for narrowing which entities that node matches
2026-08-26 Integration Toolkit API
- New
GET /v1/entities/{entityId}/sync-statusendpoint added for reading how an entity is synced with the connected external system โ each reported sync state carries an optionallast_operationandlast_synced_at, plus optionalreadings_last_event_id,readings_last_operation, andreadings_last_synced_atfor meter readings - New
POST /v1/erp/updates/direct_simulationendpoint added for simulating a direct update payload - Use cases can now be configured for direct updates through a new optional
configuration.directfield, andconfiguration.entities[].fieldsis no longer required โ accepted when creating or updating a use case or an integration, returned wherever use cases are read, and also accepted byPOST /v1/erp/updates/mapping_simulationandPOST /v2/erp/updates/mapping_simulation POST /v3/erp/updates/eventsnow accepts an optionalcorrelation_idper event
2026-08-26 Journey API
- New optional
settings.authGatefield 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 - The values of
validationRulesmay now also be arrays where only single values were returned before, so consumers reading a journey configuration must be prepared for both shapes
2026-08-26 Notification API
POST /v1/notification/notificationsnow accepts an optionaltemplate_idfor creating a notification from a notification template, and an optionalskip_user_resolutionfor delivering to the given recipients without resolving them to users first
2026-08-26 Workflows Execution API
agent_executionandagent_execution_idon a workflow task may now benullwhere an object and a string were previously returned โ affecting all flow execution and task responses (breaking)- New optional
loop_iterationsfield added to workflow tasks, reporting how often a looping task ran; tasks and phases additionally report an optionalanalytics.skipped_atwhen they were skipped, and executions an optionalanalytics.started_by_org_id
2026-08-25 Blueprint API
- New
POST /v2/blueprint-manifest/jobs/{job_id}:retryendpoint added for retrying a blueprint job that did not finish - Job progress now reports why an individual resource failed through new optional
error_codeanderror_datafields onresource_progressโ returned byGET /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
2026-08-24 Message API
- Message and thread searches can now be narrowed to a view or to user groups through new optional
viewanduser_groupsfields onPOST /v1/message/messages:search,POST /v1/message/threads:searchIds,POST /v2/message/threads:search, andPOST /v1/message/unread:counts(which takes the view per scope asscopes.view_id); the search termqis no longer required on the message and thread search endpoints
2026-08-21 Integration Toolkit API
- Use case configuration no longer supports
constants,lookups,params_mapping,required_params,file_source,fan_out.split_expression,upload.external_id, andupload.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 (breaking) - Request steps of a use case gained two new optional fields:
body_jsonatafor building the request body with a JSONata expression, andenabledfor switching a single step off; file uploads additionally accept an optionalupload.max_total_byteslimit POST /v2/erp/importsnow accepts an optionalimport_idto continue working on an existing import, answers with200in that case, and can answer with404or409when the referenced import cannot be used
2026-08-21 Message API
- New
POST /v1/message/unread:countsendpoint added for retrieving the number of unread messages
2026-08-21 Workflows API
- Journey tasks can now pass parameters into the journey they open through a new optional
context_parametersfield โ available on the regular, ECP, and installer journey configuration of a task, accepted onPOST/PUT /v1/workflows/definitionsandPOST/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
2026-08-20 Access Token API
- Access tokens now report when they expire through a new optional
expires_atfield, returned byGET /v1/access-tokens,POST /v1/access-tokens, andDELETE /v1/access-tokens/{id}
2026-08-20 Billing API
- 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 optionalcontext,effective_at,previous_value,source_label,source_reference, andsource_systemfields are no longer part of the common row, so consumers must read them from the specific row type โ affectingGET /v1/billing/billing_accounts/{id}/configuration_history,GET /v1/billing/contracts/{id}/configuration_history, and the pricing information endpoints (breaking) - Contract pricing changes are now tracked in the configuration history:
change_typeaccepts and returns the newcontract_pricing_changedvalue, and a new optionalhistory_change_typesquery parameter lets several change types be requested at once on all four configuration history and pricing information endpoints - Pricing information (
GET /v1/billing/contracts/{id}/pricing_informationandGET /v1/billing/billing_accounts/{id}/pricing_information) now returns the fullbase_pricesandworking_priceslists of a contract, reports atariff_typefor each base and working price, and accepts a new optionalinclude_historyquery parameter for returning the configuration history along with it
2026-08-20 Journey Config API
- New optional
stepperTypefield 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
2026-08-20 Event: Customer Request Submitted
- The event is now triggered from an automation instead of an entity operation โ the
operation,activity_id,activity_type, andtrigger_entityfields were removed, and_event_sourceand_trigger_source_typeare now alwaysautomation(breaking) ticket,event_attachments,_trigger_source_type, and_trigger_sourceare now always present;event_attachmentsis always sent but may be empty when the request carries no files, and_trigger_sourceidentifies the automation execution and action that triggered the request