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

Automation API

Deprecated actions[].config.candidate_group on automation flows is now deprecated in favour of the new optional actions[].config.candidate_pool field — accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows and executions are read

Changed Automation bulk jobs can now be restarted: PATCH /v1/automation/executions/bulk-jobs/{job_id} accepts the new RESTART value for action and no longer requires task_token, and bulk jobs report their restarts through new optional restart_count, restarted_at, and last_error fields

Changed Bulk jobs now report execution statistics through new optional execution_stats and execution_summary_truncated fields, and GET /v1/automation/executions/bulk-jobs/{job_id} accepts a new optional include_execution_summary query parameter

Email Settings API

Action needed Outlook mailboxes can now be synced for the last 3 months, 6 months, or year: mailboxSyncTimeframe on POST /v2/outlook/mailbox/connect and timeframe on POST /v2/outlook/mailbox/{email}/sync accept the new 3m, 6m, and 1y values, which are also returned by the sync and GET /v2/outlook/mailbox/{email}/sync/status endpoints, so consumers must be prepared for these additional timeframes

New New POST /v2/outlook/mailbox/{email}/sync/cancel endpoint was added for cancelling a running mailbox sync

Message API

Action needed GET /v1/message/threads/{id}/timeline can now return the new MessageEntityLinkSuggestedEvent and MessageEntityLinkSuggestionDismissedEvent event types, so consumers must be prepared for these additional events

Changed Messages can now come with suggested entity links: GET /v2/message/messages/{id} returns a new optional link_suggestions field, and new POST /v1/message/threads/{id}/link-suggestions/dismiss endpoint was added for dismissing suggestions

Workflows Definition API

Action needed Flow template tasks can now have a start date through new optional tasks[].start_date and tasks[].start_date_config fields, and due dates can now be set relative to it: due_date_config.type accepts the new START_DATE value on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and returns it wherever flow templates are read, so consumers must be prepared for this additional due date type

Workflows Execution API

Action needed Tasks can now have a start date through new optional start_date and start_date_config fields, returned wherever flow executions and tasks are read, and due dates can now be set relative to it: due_date_config.type accepts the new START_DATE value on the execution, phase, and task create/update endpoints and returns it wherever flow executions, phases, and tasks are read, so consumers must be prepared for this additional due date type

October 12, 2026

Identity API

Breaking partner_account was removed from operator client organizations: it is no longer accepted on POST /v1/identity/operator/clients/{client_id}/organizations and PUT /v1/identity/operator/clients/{client_id}/organizations/{org_id} and no longer returned by any operator client organization endpoint

New New GET /v1/identity/operator/clients/{client_id}/organizations/{org_id}/users/{user_id}:subject endpoint was added for reading the subject of a user in an organization

Validation Rules API

Breaking Rule conditions now use the new ValueReference shape for dynamic values: ContextValue and EnvironmentValue are no longer accepted for conditions[].value.adjust.value and conditions[].applies_when.value on POST /v1/validation-rules and PATCH /v1/validation-rules/{ruleId}, which now accept ValueReference instead

Action needed conditions[].value.offset on relative date values can now be a value reference instead of only an integer, and its ±36500 limit was removed — returned wherever validation rules are read, so consumers must handle non-integer offsets

Changed Rule conditions can now use parameters through the new ParameterValue shape, accepted for conditions[].value, conditions[].value.min/max, conditions[].value.adjust.value, and conditions[].applies_when.value on POST /v1/validation-rules and PATCH /v1/validation-rules/{ruleId} and returned wherever validation rules are read

Changed anchor on relative date values can now be a value reference, and today is no longer accepted as anchor on POST /v1/validation-rules and PATCH /v1/validation-rules/{ruleId} (breaking) — consumers must also handle non-string anchors wherever validation rules are read

Workflows Execution API

Deprecated Loop details on flow executions were extended with new optional loop_source, phases[].loop_membership, tasks[].loop_membership, tasks[].conditions[].loop_outcome, and tasks[].loops.*.depth/outer_loop_ids/target_id fields, and tasks[].loop_config on flow executions and tasks is now deprecated in favour of tasks[].loops

Changed Flow executions now carry advanced loops: tasks report their loops through a new optional tasks[].loops field and edges their loop through a new optional edges[].loop_id field — returned wherever flow executions and tasks are read

October 9, 2026

Audit Log API

Action needed Audit logs now record actions performed by AI agents: caller.trigger_type can return the new agent value, so consumers must be prepared for this additional trigger type, and callers report the acting agent and access token through new optional caller.agent, caller.token_id, caller.token_name, and caller.token_type fields — returned by POST /v1/logs and GET /v1/logs/{logId}

Changed caller_type on POST /v1/logs is no longer restricted to a fixed set of values and now also accepts a list of caller types

Design Builder API

Changed Designs can now carry a Spark theme: the design accepts the new Spark_Theme shape on POST /v1/designs and PUT /v1/designs/{designId} and returns it wherever designs are read, and GET /v1/designs/{designId}/parse returns a new optional design.spark_theme field

Integration Toolkit API

Action needed Import validation can now report the new issue codes FROM_ROWS_EXPRESSION_FAILED, MAPPING_EXPRESSION_FAILED, and VALUE_FORMAT_INVALID, and issues carry new optional attributes, expected, and lines details — returned by all /v2/erp/imports endpoints, so consumers must be prepared for these additional issue codes

Query API

Breaking GET /v2/query/autocomplete no longer accepts labels, partners, purposes, sharing_configs, tags, and workflows as the dataset query parameter

Workflows Execution API

New New POST /v2/flows/bulk-jobs/{job_id}/restart endpoint was added for restarting a bulk job, and bulk jobs link to their restarts through new optional restart_of and restarted_by fields. GET /v2/flows/bulk-jobs now also returns each job's entity_ids and entity_count, and an optional entity_schema

Changed Flows can now be started in bulk: new POST /v2/flows/executions:bulk-start endpoint was added for starting many flow executions at once, together with new GET /v2/flows/bulk-jobs, GET /v2/flows/bulk-jobs:active, GET /v2/flows/bulk-jobs/{job_id}, and PATCH /v2/flows/bulk-jobs/{job_id} endpoints for tracking and updating bulk jobs

Ticket Entity

Changed Tickets can now record consents through a new consents field

Core Events

New New GridPlantRegistrationRequested and GridPlantRegistrationProgressed events were added for plant registration processes, and a new GridConnectionProgressed event was added for tracking a grid connection process after it was requested. The Progressed events carry a stage describing where the process stands, including a required stage.workflows list with the definition_id, status, current phase, and current task of every workflow on the opportunity

Changed GridConnectionRequested now includes the related business accounts through a new accounts field

October 8, 2026

Access Token API

New New agent authentication endpoints were added under /v1/access-tokens/agent-auth for authenticating AI agents: discovery through GET .well-known/agent-configuration and GET .well-known/jwks.json; agent lifecycle through POST agent/register, agent/introspect, agent/reactivate, agent/revoke, agent/rotate-key, and GET agent/status; user approval through GET and POST approvals/{user_code}; capabilities through GET capability/list, GET capability/describe, POST agent/request-capability, and POST capability/execute; host management through POST host/revoke and host/rotate-key; and agent management through GET agents and DELETE agents/{agent_id}

New New AgentAuthAgent and AgentAuthHost security schemes were added for authenticating agent and host requests

Pricing API

New New POST /v2/public/catalog endpoint was added as a new version of POST /v1/public/catalog

Changed Line items can now reference the catalog entry they came from through a new optional catalog_reference field — accepted on POST /v1/order, PUT /v1/order/{id}, POST /v1/pricing:compute, and POST /v1/public/cart:checkout, and returned wherever line items and pricing details are read

Query API

New Chart templates can now belong to the new service category: category on GET /v2/query/chart-templates can return service, so consumers must be prepared for this additional category

Changed Query results now report the queried time range and period comparison through new optional timeRange and comparison fields — returned by POST /v1/query:execute, POST /v2/query:execute, and POST /v2/query/domain/entities:execute

Changed The semantic model (GET /v2/query/semantic-model) now includes a new required tables.analytics_datasets table

October 7, 2026

Snapshot API

New New GET /v1/snapshots/{id}/restores/{index} endpoint was added for reading a single restore of a snapshot, and POST /v1/snapshots/{id}:restore now returns the restore_index of the started restore

Changed POST /v1/snapshots, POST /v1/snapshots:capture-org, and POST /v1/snapshots/{id}:restore can now respond with 409 when a conflicting operation is already in progress

Webhooks API

Action needed Webhook events are now retried automatically: event status can return the new retrying value, and events report their retry progress through new optional attempts, max_retry_attempts, and next_retry_at fields — returned by GET /v1/webhooks/configs/{configId}/events, GET /v1/webhooks/configs/{configId}/events/{eventId}, and POST /v2/webhooks/configs/{configId}/events (which also accepts retrying as a status filter), so consumers must be prepared for this additional status

October 6, 2026

Automation API

Action needed actions[].config.assignees on automation flows now supports the new EntityAssignee and EntityAssigneeVariable assignee types — accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows and executions are read, so consumers must be prepared for these additional assignee types

Entity API

New New GET /v1/entity:import:latest endpoint was added for reading the latest entity import, and new POST /v1/entity:discardImport endpoint was added for discarding an import

Changed Entity imports can now be run as a dry run: POST /v1/entity:import accepts new optional dry_run and dry_run_job_id fields, as well as a new optional unique_key field

Changed Entity imports can now trigger automations through a new optional trigger_automations field on POST /v1/entity:import, and imports report who started them through a new optional started_by field

October 5, 2026

Automation API

Action needed Automation flows can now be triggered by sent emails: a new SentEmailTrigger trigger shape is accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows are read, and executions report the new sent_email value as their trigger_event.type — so consumers must be prepared for these additional trigger and trigger event types

Dashboard API

Action needed A new notes visualisation was added: visualisation_id on dashboard tiles and insights accepts and returns the new notes value, so consumers must be prepared for this additional visualisation type

Changed Dashboards can now be filtered through a new optional filters field, with per-tile tiles[].filter_settings — accepted when creating or updating a dashboard and returned wherever dashboards are read

Event Catalog API

Deprecated Catalog events now report when they were deprecated through a new optional deprecated_at field, and event mappings support a new optional mapping.payload field, accepted on POST /v1/events and PUT /v1/events/{event_name}

Changed Catalog events can now be changed through a draft version before publishing: new GET, PUT, and DELETE /v1/events/{event_name}/version_draft endpoints for managing the draft and POST /v1/events/{event_name}/version_draft:publish for publishing it