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

Workflows Execution API, Scheduler API

New Put flow tasks on hold โ€” Tasks can be put on hold, and a hold can be expired manually or by a schedule. Be prepared for the new hold expiry target type when reading schedules.

API details
  • PATCH /v2/flows/executions/{execution_id}/tasks/{task_id} accepts a new optional put_on_hold field
  • Tasks return new optional hold and on_hold_config fields wherever executions and tasks are read
  • New POST /v2/flows/executions/{execution_id}/tasks/{task_id}/hold/expire endpoint for expiring a task hold
  • Schedules support a new flow task hold expiry target type, accepted on POST /v1/schedules, PATCH /v1/schedules/{schedule_id}, and PUT /v1/schedules/{schedule_id} and returned wherever schedules are read

Snapshot API

New Partial snapshot restore โ€” Restore only selected targets of a snapshot and follow the progress of a restore.

API details
  • POST /v1/snapshots/{id}:restore accepts a new optional include_target_ids field
  • GET /v1/snapshots/{id}/restores/{index} returns new optional progress and total fields and accepts a new optional action filter

Core Events

New All related billing accounts on events โ€” Contact- and ticket-related events now include the full list of related billing accounts. The existing single billing_account and account fields are unchanged, and consumers pinned to an earlier event version keep receiving the previous payload.

API details
  • New billing_accounts field on TariffChange, TerminateContractRequested, GeneralRequestCreated, BillingAccountConnectionRemoved, ServiceInstallmentChange, and ContractWithdrawalRequested (version 1.1), CustomerRequestSubmitted (version 1.2), and LocationMoveRequested (version 2.1)
  • New accounts list on CustomerDetailsUpdated (version 1.1)

November 13, 2026

Blueprint Manifest API

Action needed New blueprint job error codes โ€” Blueprint job errors can report custom_schema_id_conflict and custom_schema_check_unavailable, with a new optional conflictingResource detail.

New Duplicate test cases and run selected ones โ€” Blueprint test cases can be duplicated, and a test suite run can be limited to selected test cases.

API details
  • New POST /v2/blueprint-manifest/blueprints/{blueprint_id}/test-cases/{test_case_id}/duplicate endpoint
  • New optional case_ids field on POST /v2/blueprint-manifest/blueprints/{blueprint_id}/test-suite/runs
  • expectation is now optional on PUT /v2/blueprint-manifest/blueprints/{blueprint_id}/test-cases/{test_case_id}

Document API

New Generate documents from file entity templates โ€” Document generation can use a template stored as a file entity, and the document layout can be chosen.

API details
  • New optional template_document.file_entity_id field on POST /v2/documents:generate
  • New optional template_settings.layout_mode field

File Entity

New Layout mode for document templates โ€” Document template files have a new docgen_layout_mode attribute (org_default, legacy, or improved) for choosing the layout used when generating documents.

November 12, 2026

Automation API

New Conditions and loops in automations โ€” Automation actions can run conditionally and in loops, and triggers can have conditions.

API details
  • Actions accept new optional conditions, conditionMode, and loop_config settings
  • Triggers accept new optional conditions
  • Accepted on POST /v1/automation/flows, PUT /v1/automation/flows/{flow_id}, and POST /v1/automation/executions:ephemeral, and returned wherever flows and executions are read

Workflows Definition API, Workflows Execution API

New Assignee sync setting โ€” Flow templates and executions, and their phases and tasks, have a new optional assignee_sync setting.

API details
  • Accepted on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and returned wherever flow templates are read
  • Accepted on PATCH /v2/flows/executions/{execution_id}, PATCH /v2/flows/executions/{execution_id}/phases/{phase_id}, and PATCH /v2/flows/executions/{execution_id}/tasks/{task_id}, and returned wherever executions and tasks are read

November 11, 2026

AI Agents API

New Journey input parameters for agents โ€” Agent input parameters support the new journey, journey-task, and journey-context types. Be prepared for them wherever agents are read.

API details
  • Accepted when creating or updating agents (POST /v1/agents, PUT /v1/agents/{agent_id})
  • Accepted in agent_override on POST /v1/agents/{agent_id}/execute/stream and POST /v1/chat

New File attachments for agent executions โ€” POST /v1/agents/{agent_id}/execute and POST /v1/agents/{agent_id}/execute/stream accept a new optional input.attachments field.

New Execution screenshots โ€” GET /v1/executions/{execution_id}/screenshots returns the screenshots captured during an agent execution.

Configuration Hub API

Action needed New health check finding codes โ€” Health checks can report the new env_value_missing and secret_value_missing finding codes.

New Conflict detection in sync job plans โ€” Sync job plans report conflicts, which can be filtered and overwritten. Applying or replanning a plan with unresolved conflicts can fail with the new unresolved_conflicts error code.

API details
  • Plans, plan summaries, and plan resources return new optional conflicts details, with per-resource conflict_resolution and a plan-level conflicts_checked_at
  • GET /v1/configs/sync-jobs/{id}/resources accepts a new optional has_conflicts filter
  • POST /v1/configs/sync-jobs/{id}/plan/apply accepts a new optional overwrite_conflicts flag
  • The unresolved_conflicts error comes with optional message and resources details

New Configuration previews โ€” Create and read configuration previews.

API details
  • GET and POST /v1/previews and GET /v1/previews/{id}

Changed Health check findings restructured โ€” The findings returned by the sync job health endpoints were restructured into a composed schema. Clients relying on the previous generated response types may need to update.

API details
  • Affects GET /v1/configs/sync-jobs/{id}/health and POST /v1/configs/sync-jobs/{id}/health:run
  • Both endpoints return a new optional baseline field

Customer Portal API

Deprecated feature_settings.new_design โ€” The portal configuration field is deprecated in both requests and responses across the portal configuration endpoints.

New Meters and meter readings for portal users โ€” Portal users can view their meters and counters and submit meter readings.

API details
  • GET /v2/portal/metering/contract/{contract_id}/meters
  • GET /v2/portal/metering/meter/{meter_id} and GET /v2/portal/metering/meter/{meter_id}/counters
  • GET /v2/portal/metering/counter/{counter_id}
  • GET /v2/portal/metering/meter/{meter_id}/allowed-reading
  • POST /v2/portal/metering/meter/{meter_id}/readings

New Changed Portal configuration validation โ€” Portal configurations can be validated, and saving, publishing, and creating revisions can return a validation result. The responses of those endpoints were restructured, so clients relying on the previous generated response types may need to update.

API details
  • New POST /v3/portal/config/{portal_id}/validate endpoint
  • Restructured responses: POST /v2/portal/portal, POST /v3/portal/config, PUT /v3/portal/config/{portal_id}, POST /v3/portal/config/{portal_id}/publish, and POST /v3/portal/config/{portal_id}/revisions

Minor Mobile app configurations accept and return new optional ota.min_supported_native_version and ota.recommended_native_version fields for controlling which native app versions are supported

Design Builder API

Breaking Deprecated endpoints removed โ€” GET /v1/brands and GET /v1/designs/limit were removed.

New Asynchronous document generation โ€” Start a document generation job and track it.

API details
  • POST /v1/designs/document/generate/jobs
  • GET /v1/designs/document/generate/jobs/{jobId}

Entity Mapping API

Breaking Mapping history removed โ€” The deprecated GET /v1/mappings/history endpoint was removed.

Event Catalog API

New Limit entity operation triggers to attribute values โ€” Entity operation triggers of events can be limited to specific attribute values.

API details
  • New optional entity_operation.attribute_values field, accepted when creating or updating events and event version drafts and returned wherever events are read

Organization API

New Preview organizations โ€” Organizations can report the new Preview value for organization_use, which is also accepted by PATCH /v2/organization/{org_id}.

Phone Integration API

New Active call โ€” Read, update and clear the active call through GET, PUT, and DELETE /v1/calls/active.

Campaign Entity

New Campaign type and product recommendations โ€” Campaigns have a new type attribute (currently supporting tariff_change) and a new product_recommendations relation.

New Add recipients automatically โ€” Campaigns have a new auto_add_recipients attribute for automatically adding new recipients to a campaign.

Product Recommendation Entity

Breaking active removed โ€” The active attribute was removed from product recommendations.

Event: Email Delivery Failed

New Email delivery failed event โ€” A new EmailDeliveryFailed event fires when an email bounces, is rejected, or cannot be sent.

API details
  • Includes the message_id, thread_id, sender, affected recipients, status (BOUNCE, REJECT, or ERROR), error_detail, and provider
  • Optional message metadata: subject, sent_at, sent_by_user_id, tags, thread_topic, inbox_bucket_id, email_message_id, related_entities
  • Sender attribution for filtering and routing webhooks: send_source, automation_flow_ids

Event: Portal User Logged In

Breaking Published directly from portal logins โ€” The event is no longer derived from portal user entity updates, so the operation, activity_id, activity_type, and trigger_entity fields were removed.

New Logins on behalf of the customer โ€” The event now also fires when an epilot or partner user logs in as the customer.

API details
  • New is_admin_login field
  • New optional admin_user_id, admin_email, and admin_org_id fields

Event: Portal User Registered

Breaking Published directly from portal registrations โ€” The event is no longer derived from portal user entity changes. It no longer fires for email changes, manual edits, or imports, and the operation, activity_id, activity_type, and trigger_entity fields were removed.

November 10, 2026

Entity Mapping API

New Validate mappings โ€” POST /v1/mappings:validate validates mappings.

Pricing API

New Grid operator condition formats โ€” Conditional pricing conditions support the new power_grid_operator and gas_grid_operator formats.

API details
  • Returned by GET /v1/conditional-pricing/{slug}/condition-sets and GET /v1/conditional-pricing/{slug}/conditions:usage

New Where conditions are used โ€” GET /v1/conditional-pricing/{slug}/conditions:usage returns where conditional pricing conditions are used.

Minor POST /v1/public/integration/{integrationId}/providers:search accepts a new optional grid_filter field

Targeting API

Breaking Campaign dates are date-time values โ€” start_date and end_date returned by POST /v1/campaign/{campaign_id}/status and POST /v1/campaign:match are now date-time values instead of dates.

New Scheduled campaigns โ€” Campaigns can be scheduled with a start and end date. Be prepared for the new scheduled status.

API details
  • POST /v1/campaign:setup accepts new optional campaign.start_date and campaign.end_date fields
  • Campaigns can report the new scheduled status
  • POST /v1/campaign/{campaign_id}/status can respond with 409

New Campaign summaries โ€” POST /v1/campaigns:summary returns campaign summaries.

Changed Campaign setup takes a list of product recommendations โ€” POST /v1/campaign:setup requires a new product_recommendations field and exactly one target, and its response changed.

API details
  • product_recommendations is required and replaces the removed product_recommendation field
  • campaign.target_ids must contain exactly one target
  • The response returns a required product_recommendation_ids list instead of product_recommendation_id and no longer returns journey_id

Minor Campaigns returned by POST /v1/campaign/{campaign_id}/status and POST /v1/campaign:match include new optional type and product_recommendations fields

Campaign Entity

Breaking Campaign dates are date-time values โ€” start_date and end_date are now date-time values instead of dates.

New Scheduled status โ€” Campaigns support the new scheduled status.