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

Journey Config API

Changed Journeys read from the API now always carry an explicit settings.isActive flag, indicating whether the journey is accessible to end customers โ€” returned by GET /v1/journey/configuration/{id} and GET /v2/journey/configuration/{id}; the flag stays optional in request bodies

August 11, 2026

Automation API

New New optional workflow_context._automation_chain field added to automation executions, recording the chain of automations an execution was started from โ€” accepted on POST /v1/automation/executions and returned by the execution list, read, search, delete, and POST /v1/automation/public/executions:resume endpoints

Design Builder API

New New POST /v1/designs/{designId}/duplicate endpoint added for creating a copy of an existing design

Workflows Execution API

New New optional _automation_chain field added to flow executions, recording the chain of automations an execution was started from โ€” returned by POST /v2/flows/executions, GET/PATCH /v2/flows/executions/{execution_id}, POST /v2/flows/executions:search, and the reconcile-automation endpoint

August 10, 2026

Blueprint API

New New optional performed_by field added to blueprint deployments, identifying who performed a deployment โ€” 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

Query API

Breaking The semantic model (GET /v2/query/semantic-model) now reports version 3; the value 2 is no longer returned

Breaking The tables.entity_relationships table was removed from the semantic model and replaced by a new tables.entity_edges table

Breaking Relationship mechanism values were renamed โ€” entity_relationships is now entity_relation and workflow_contexts is now workflow_context

Breaking columns on the entity, purpose, and taxonomy tables is now optional and may be absent

New New required capabilities and conventions.workflow_org_id_padding fields added to the semantic model response

Targeting API

New New POST /v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:restore endpoint added for restoring a dismissed entity UI, together with a new optional entity_ui_status_before_dismiss field on recipient responses recording the status a recipient had before being dismissed

Changed Campaign discovery (POST /v1/campaign:discover) now always returns a dismissed flag, along with an optional status_updated_at timestamp

Workflows Execution API

New New optional heal_attempts and last_heal_attempted_at fields added to workflow tasks, reporting how often a task was auto-healed and when it was last attempted โ€” returned by all flow execution and task endpoints

New New optional next_condition_ids request field accepted on PATCH /v2/flows/executions/{execution_id}/tasks/{task_id}, for setting which conditions a task continues to

Event: File Updated

New New FileUpdated event added, fired whenever an existing file entity is updated โ€” like FileCreated it carries the file attachment reference (entity ID, S3 reference, and file metadata such as filename, MIME type, size, and version index) together with the hydrated file entity, so webhooks can react to changes on a file and receive its content

August 9, 2026

Query API

Changed Query results now include an optional columns field describing the columns of the returned data, added to the 200 response of POST /v1/query:execute, POST /v2/query:execute, and POST /v2/query/domain/entities:execute

August 7, 2026

Automation API

New New optional use_uniqueness_criteria field added to automation action configuration, accepted on POST/PUT /v1/automation/flows/{flow_id} and 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 6, 2026

Blueprint API

Changed Adding resources to a blueprint (POST /v2/blueprint-manifest/blueprints/{blueprint_id}/resources and POST /v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk) now reports partial failures โ€” new optional errors, total_errors, errors_truncated, and skipped fields were added to the response, so a 200 no longer means every requested resource was added

Calendar API

New New GET/PUT/DELETE /v1/calendar/working-hours/users/{user_id} endpoints added for reading, setting, and removing the working hours of a user

Changed Absence intervals can now originate from working hours โ€” source may be working_hours on GET /v1/calendar/absence/users, GET /v1/calendar/absence/users/{user_id}, POST /v1/calendar/absence:search, and POST /v1/calendar/absence:search-now, and a new optional working_hours_granularity parameter controls how finely those intervals are split

Dashboard API

New New optional favorite and favorites_first query parameters added to GET /v1/dashboard/dashboards for returning only favorites or listing them first, and a favorited flag is now returned on the dashboard list, read, create, update, and delete responses

Changed Dashboards can now be marked as favorites: new PUT/DELETE /v1/dashboard/dashboards/{id}/favorite endpoints added for marking and unmarking a dashboard, and GET /v1/dashboard/dashboards/favorites for listing the favorited ones

Entity API

New New optional adjust_installment field added to entity schema capabilities โ€” settable via POST/PUT /v1/entity/schemas/capabilities/{composite_id} and PUT /v1/entity/schemas/{slug}, and returned by the schema, capability, available-capability, and blueprint read endpoints

Message API

Action needed Thread timelines (GET /v1/message/threads/{id}/timeline) now also report workflow started, thread user assigned, message label added and removed, message entity linked and unlinked, auto-reply sent, and thread moved to inbox, trashed, and restored events, so consumers must be prepared for these additional event shapes in events[].data

New New optional id, message_id, actor, source, automated, and automation fields added to timeline events, identifying the event and who or what triggered it

User API

New New optional parent_production_org_id field added to LoginParameters responses, identifying the production organization a login belongs to โ€” returned by GET /v1/users/username/{username}:getLoginParameters, GET /v2/users/public/username/{username}:getLoginParameters, and POST /v2/users/public/passkeys:resolveCredential

Workflows Execution API

Breaking automation_execution_id and schedule.schedule_id on workflow tasks may now be null where a string was previously guaranteed โ€” affecting all flow execution and task responses (POST /v2/flows/executions, GET/PATCH /v2/flows/executions/{execution_id}, the task create, update, execute, automation-run, reconcile-automation, and schedule run-now endpoints, and POST /v2/flows/executions:search)

Journey Entity

New New journeys relation added to the journey entity, letting a journey be linked to other journeys

August 5, 2026

App API

New New optional icon_url field added to apps, returned by GET /v1/app, GET /v1/app/{appId}, POST /v1/app/{appId}, and POST /v1/app/{appId}/promote-to/{version}

Automation API

New New POST /v1/automation/executions:search endpoint added for searching automation executions

Calendar API

New New POST /v1/calendar/events/{event_id}/share and DELETE /v1/calendar/events/{event_id}/share/{user_id} endpoints added for sharing a calendar event with a user and for revoking that share

New New optional include_busy parameter added to GET /v1/calendar/absence/users, GET /v1/calendar/absence/users/{user_id}, POST /v1/calendar/absence:search, and POST /v1/calendar/absence:search-now, including busy time from users' calendars in the returned intervals

Changed Absence adjustments now carry a status, which is required when creating one via POST /v1/calendar/absence/users/{user_id}/adjustments and is always returned by the adjustment read, list, create, and update endpoints; an optional type field was added alongside it

Workflows Definition API

Changed Flow template search (POST /v2/flows/templates:search) now supports sorting by name, id, and enabled in addition to the previously available sort_by values

August 4, 2026

App API

New New widget app component type added โ€” configuration.type now accepts widget on POST/PATCH /v1/app-configurations/{appId}/versions/{version}/components and returns it on the app, app-configuration, and public component read endpoints

Pricing API

New New GET /v1/conditional-pricing/{slug}/condition-sets endpoint added, returning the condition sets defined for a conditional pricing

Changed The tax field on line item taxes now also accepts and returns the Tax and TaxItem object shapes, in addition to the previously supported ones โ€” affecting POST /v1/order, PUT /v1/order/{id}, POST /v1/pricing:compute, POST /v1/public/cart:checkout, and the public external-catalog and product-recommendation endpoints (breaking for consumers that assume a fixed shape for tax)