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

November 9, 2026

Blueprint Manifest API

New Source drift tracking โ€” Blueprints can track drift from their source organization. Be prepared for the new source_resources_missing job error code.

API details
  • New optional source_drift field, accepted on POST /v2/blueprint-manifest/blueprints and PUT /v2/blueprint-manifest/blueprints/{blueprint_id} and returned wherever blueprints and blueprint jobs are read
  • Job errors can report source_resources_missing with optional missing_count and exclude_count details

Entity API

New Grid operator condition formats โ€” Entity schema conditions support the new power_grid_operator and gas_grid_operator formats, accepted by PUT /v1/entity/schemas/{slug} and returned wherever entity schemas are read.

Integration Toolkit API

New Sandbox lane for ERP update events โ€” ERP update events can be processed in a new sandbox lane. Be prepared for the new lane value and monitoring code.

API details
  • lane is returned by POST /v1/erp/updates/events, POST /v2/erp/updates/events, POST /v3/erp/updates/events, and GET /v3/erp/updates/events/{event_id}
  • Monitoring events, associated events, and trace spans can report the new SANDBOX_LANE code

Journey Config API

New Reusable journey partials โ€” Journeys can be built from reusable partials, and you can list where a partial is used.

API details
  • Journey configurations accept and return new optional partials, partialContract, and steps[].partialOrigin fields across the v1 and v2 configuration endpoints
  • Journey revisions return new optional partial_warnings
  • New GET /v1/journey/partials/{id}/usages endpoint

Changed Response of journey configuration updates restructured โ€” The response of PATCH /v2/journey/configuration and PUT /v2/journey/configuration now combines the journey configuration with partial warnings. Clients relying on the previous generated response type may need to update.

Minor DELETE /v1/journey/configuration/{id} and DELETE /v2/journey/configuration/{id} can respond with 409

Webhooks API

New Revision history for webhook configurations โ€” Webhook configurations keep a revision history that can be read and restored from.

API details
  • New GET /v1/webhooks/configs/{configId}/revisions and GET /v1/webhooks/configs/{configId}/revisions/{revisionId} endpoints
  • PUT /v1/webhooks/configs/{configId} accepts new optional based_on_revision_id and restored_from_revision_id query parameters and can respond with 409 on conflicting changes

Workflows Execution API

New Reschedule tasks โ€” Scheduled tasks can be rescheduled.

API details
  • New PUT /v2/flows/executions/{execution_id}/tasks/{task_id}/schedule endpoint
  • Scheduled tasks return a new optional schedule.rescheduled field

Lead Entity

Changed Lead scoring attributes removed โ€” The lead scoring attributes were removed from the lead schema and replaced by the scoring capability.

API details
  • lead_score, lead_score_grade, lead_score_status, lead_score_calculated_at, lead_score_reasoning
  • The sub-score fields score_urgency, score_system_size, score_partner, score_property, score_data_quality, score_switching_pressure, score_customer_relationship, score_source

November 8, 2026

Email Settings API

New Sync Outlook mailboxes from a custom date or the last day โ€” Mailbox syncs can start from a custom date or cover just the last day. Be prepared for the new 1d and custom timeframe values.

API details
  • POST /v2/outlook/mailbox/{email}/sync accepts a new optional since field, and timeframe is now optional
  • Sync timeframes support the new 1d and custom values, also accepted by POST /v2/outlook/mailbox/connect as mailboxSyncTimeframe
  • GET /v2/outlook/mailbox/{email}/sync/status returns a new optional timeframe_start field

New Estimate a mailbox sync โ€” GET /v2/outlook/mailbox/{email}/sync/estimate estimates a mailbox sync.

November 6, 2026

Automation API

Breaking Email forwarding targets accept environment variables โ€” forward_to[].email in automation actions accepts environment variable references such as {{ env.my_variable }} in addition to plain email addresses. The field no longer uses the email format and follows a new pattern instead, across the flow and execution endpoints. This breaks clients that validate the field as an email.

Customer Portal API

Breaking Header icon action overrides use variant โ€” header.design.overrides.elements.icon_actions no longer supports the color and style fields, which were replaced by a new variant field, in both requests and responses across the portal configuration endpoints.

New Validate portal identifiers with validation rules โ€” Portal registration and contact identifiers can be validated with validation rules.

API details
  • Identifiers accept and return a new optional validation_rule_id
  • Portal configurations return a new optional registration_validation_rules field

New Configurable portal header โ€” Portal headers can be configured through a new optional header field.

API details
  • Accepted on POST /v2/portal/portal, POST /v3/portal/config, PUT /v3/portal/config/{portal_id}, and POST /v3/portal/config/{portal_id}/revisions and returned wherever portal configurations are read
  • Portal configurations also return a new optional engagement_center_title field

Design Builder API

New Generate documents from designs โ€” POST /v1/designs/document/generate generates documents from designs.

Changed Spark theme removed โ€” Designs no longer include Spark theme properties in requests or responses across the design endpoints, and GET /v1/designs/{designId}/parse no longer returns design.spark_theme.

Validation Rules API

New Validation rules for customer portals โ€” Validation rules can be linked to customer portals. Be prepared for the new portal value for used_by types, which is accepted and returned across the validation rule endpoints.

November 5, 2026

Automation API

New Ephemeral automation executions โ€” Run an automation execution without keeping it.

API details
  • New POST /v1/automation/executions:ephemeral endpoint
  • Executions return a new optional ephemeral flag

Workflows Definition API

New Tasks only the assignee can complete โ€” Flow template tasks can be limited so that only the assignee can complete them.

API details
  • New optional only_assignee_can_complete field, accepted on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and returned wherever flow templates are read

Workflows Execution API

New Bulk job items โ€” GET /v2/flows/bulk-jobs/{job_id}/items returns the items of a bulk job.

Changed Bulk jobs start flows for a query โ€” Bulk jobs can start flows for all entities matching a query. Starting a bulk job is limited to one flow template, and the bulk job response changed.

API details
  • POST /v2/flows/executions:bulk-start accepts a new optional entities_query and a new optional flow_template_id
  • entities is now optional and accepts up to 1000 entities (previously 200)
  • flow_template_ids is deprecated and limited to a single template
  • Bulk jobs return a required flow field, and every bulk job endpoint except GET /v2/flows/bulk-jobs also returns a required entity_count
  • New optional fields entities_matched, entities_query, entity_schema, failure, and preparation, and jobs can report the new preparing status
  • The flows and items fields are deprecated and now optional

Minor Flow executions started by a bulk job return a new optional trigger.bulk_job_id field

November 4, 2026

Access Token API

New First-party agents and token exchange โ€” Register first-party agents and exchange tokens.

API details
  • New POST /v1/access-tokens/agent-auth/first-party/agents endpoint
  • New POST /v1/access-tokens/agent-auth/token-exchange endpoint
  • Agents listed by GET /v1/access-tokens/agent-auth/agents include a required mode field and new optional first_party and owner fields
  • GET /v1/access-tokens/agent-auth/agent/status returns a new optional owner_user_id

Configuration Hub API

New Organization settings as configuration resources โ€” Organization settings can be managed as configuration resources through the new org_setting resource type, which is accepted and returned across the compare, inventory, lineage, types, and resource endpoints.

New Plan sync jobs before applying them โ€” Sync jobs can be planned, reviewed and approved before they are applied.

API details
  • New GET /v1/configs/sync-jobs/{id}/plan, POST /v1/configs/sync-jobs/{id}/plan/apply, and POST /v1/configs/sync-jobs/{id}/plan/replan endpoints
  • New GET /v1/configs/sync-jobs/{id}/plan/diffs and GET /v1/configs/sync-jobs/{id}/plan/diffs/{type}/{source_id} endpoints
  • Sync jobs return new optional planning and approval fields: plan_only, plan_summary, planned_at, expires_at, approvals, approved_at, approved_by, applied_by, applied_from_plan
  • GET /v1/configs/sync-jobs/{id}/resources accepts a new optional plan_action filter and returns per-resource plan and excluded_from_apply fields

New Health checks for sync jobs โ€” Sync jobs can be health-checked. Be prepared for the new source_org_reference finding code.

API details
  • New GET /v1/configs/sync-jobs/{id}/health and POST /v1/configs/sync-jobs/{id}/health:run endpoints
  • Sync jobs return a new optional health_check field
  • GET /v1/configs/health can report the new source_org_reference finding code

Minor Error responses across the Configuration Hub endpoints include a new optional machine-readable code field

Customer Portal API

Breaking Deprecated file endpoints removed โ€” The portal user file list endpoints were removed, and file relation titles are no longer returned.

API details
  • GET /v2/portal/user/files and GET /v2/portal/user/files/count-by-entity were removed
  • file._relations[]._title is no longer returned by GET /v2/portal/user/file/{id} and POST /v2/portal/user/file/{id}/downloaded

New Publish portal configuration revisions directly โ€” A revision can be published when it is created, and publishing can be forced.

API details
  • New optional publish and base_published_revision_id fields on POST /v3/portal/config/{portal_id}/revisions, which returns a new optional published flag
  • POST /v3/portal/config/{portal_id}/publish accepts a new optional force field

New Conflict detection on portal configuration changes โ€” Portal configuration endpoints can respond with 409 on conflicting changes.

API details
  • Portal configuration, page, block, email template, mobile config, and portal file endpoints can respond with 409
  • PUT /v3/portal/config/{portal_id} can also respond with 413 and accepts a new optional expected_updated_at query parameter for detecting conflicting updates

Minor POST /v2/portal/portal/files and POST /v3/portal/portal/files accept a new optional draft flag

Phone Integration API

New Queue and routing configuration โ€” Configure queue settings, skills and call handling.

API details
  • GET and PUT /v1/manager/queues/{queue_id}/settings
  • PUT and DELETE /v1/manager/queues/{queue_id}/skills/{tag}
  • GET and POST /v1/manager/skills and DELETE /v1/manager/skills/{tag}
  • GET and PUT /v1/manager/settings/call-handling

New Monitoring, reporting and missed calls โ€” Read live KPIs, agent activity and reports, and handle missed calls.

API details
  • GET /v1/manager/live/kpis and GET /v1/manager/agents/{provider_agent_id}/activity
  • GET /v1/manager/reporting/agents and GET /v1/manager/reporting/queues
  • GET /v1/manager/missed-calls and POST /v1/manager/missed-calls/{call_id}/callback

Changed Date-time values for call reporting โ€” The from and to query parameters on GET /v1/manager/reporting/calls must now be date-time values.

Minor Live and queue endpoints report a new optional expected_wait_seconds field, queue routing includes a required team_members list, and agent routing accepts a new optional include_own_steps field

User API

New Require SSO for users โ€” Users can be required to sign in with SSO through a new optional sso_required field, accepted on PATCH /v2/users/{id} and returned wherever users and group members are read.

November 3, 2026

AI Agents API

New Agent sessions โ€” Run and manage agent sessions, including their events, files and script runs.

API details
  • GET and POST /v2/sessions and GET, PATCH, and DELETE /v2/sessions/{sessionId}
  • GET and POST /v2/sessions/{sessionId}/events
  • GET /v2/sessions/{sessionId}/files/{fileId} and POST /v2/sessions/uploads
  • POST /v2/sessions/scripts, GET /v2/sessions/scripts/{runId}, and POST /v2/sessions/scripts/{runId}/apply for session script runs

New Revoke agents โ€” POST /v2/agents/revoke revokes agents.

Design Builder API

Deprecated Consumer and parse endpoints โ€” The endpoints for adding and removing design consumers and for parsing a design are deprecated.

API details
  • PUT /v1/designs/addConsumer/{application}/{designId}
  • PUT /v1/designs/removeConsumer/{application}/{designId}
  • GET /v1/designs/{designId}/parse

New Safe concurrent design updates โ€” Send If-Match when updating a design so you don't overwrite a change made in the meantime; the update then fails with 409 instead.

API details
  • PUT /v1/designs/{designId} accepts a new optional If-Match header and can respond with 409

Email Settings API

New Two years of Outlook history โ€” Outlook mailboxes can now sync up to two years of history. Be prepared for the new 2y timeframe value.

API details
  • mailboxSyncTimeframe on POST /v2/outlook/mailbox/connect accepts 2y
  • timeframe on POST /v2/outlook/mailbox/{email}/sync accepts 2y
  • GET /v2/outlook/mailbox/{email}/sync/status can return 2y

File API

New Meter reading suggestions from files โ€” Generate meter reading suggestions from uploaded files, then read and update them.

API details
  • GET and POST /v1/files:meterReadingSuggestions
  • PATCH /v1/files:meterReadingSuggestions/{meter_id}/{file_id}/{suggestion_id}

November 2, 2026

Entity Mapping API

New Chained mapping targets โ€” A mapping target can now relate to the entities produced by another target.

API details
  • Relation attribute source filters accept a new optional source_filter.output_of field, when creating or updating mappings and versions and on POST /v1/mappings:execute and POST /v1/relations:execute; it is returned wherever mappings are read
  • POST /v1/mappings:execute and POST /v1/relations:execute accept a new optional outputs field