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

January 14, 2026

Data Management API

Breaking related_entities_any_in_closed_or_cancelled_status filter type was removed

January 12, 2026

Blueprint Manifest API

Breaking POST /v2/blueprint-manifest/blueprints:pre-install response changed from Blueprint to BlueprintPreview schema

New New GET /v2/blueprint-manifest/blueprints:preview/{preview_id} endpoint was added

January 9, 2026

Customer Portal API

New New v3 portal management endpoints were added: distribution config, email templates, entity access, extensions, external links, portal config, SSO login, user management, and CAA record validation

Core Events

New New BillingAccountConnectionRemoved event was introduced

New New GeneralRequestCreated event was introduced

New New LocationMoveRequested event was introduced

New New TerminateContractRequested event was introduced

January 8, 2026

Pricing API

Changed postal_code is now required in availability location filter objects

Kanban API

New New PUT /v1/kanban/org/default-board and DELETE /v1/kanban/org/default-board endpoints were added

Metering API

New New POST /v1/metering/readings/{meter_id} endpoint was added for portal-authenticated meter reading submissions

January 7, 2026

Data Management API

New New POST /data-management/v1/configs/{config_id}/jobs endpoint was added to manually trigger job runs

New New GET /data-management/v1/jobs/{job_id} endpoint was added

New New related_entities_workflows_only_in_closed_or_cancelled_status filter type was added

December 31, 2025

Event Catalog API

New New Event Catalog API launched with endpoints to list events, retrieve configurations and schemas, generate sample payloads, update configuration, search event history, and trigger events

December 30, 2025

Customer Portal API

Deprecated GET /v2/portal/user/files and GET /v2/portal/user/files/count-by-entity are now deprecated

Blueprint Manifest API

New New GET /v2/blueprint-manifest/blueprints:marketplace endpoint was added for listing installed marketplace blueprints

Metering API

Changed note field was renamed to remark on meter reading create and update operations

December 26, 2025

Location Entity

New New location entity was introduced with address, address_hash, and entity_relations properties

December 23, 2025

Pricing API

New New public external catalog endpoints were added for products and product recommendations

Changed External catalog context now supports CustomContext alongside JourneyContext

December 22, 2025

Customer Portal API

Breaking Meter reading note field was renamed to remark

New New detail_schema field was added to page configuration

December 19, 2025

Customer Portal API

New New self_registration_setting values were added: ALWAYS_CREATE_CONTACT, BLOCK_IF_PORTAL_USER_EXISTS, DISALLOW_COMPLETELY

Data Management API

Breaking lookback_period_months was replaced by lookback_period_days

New New endpoints were added: get config by ID, list jobs with filtering, and job report download URL

Changed email entity type was replaced by message in relations_for_deletion

December 18, 2025

Customer Portal API

Deprecated meter_id is now optional (deprecated) on consumption, costs, and prices endpoints

New New context_entities parameter was added as a replacement

December 17, 2025

ERP Integration API

New New POST /v1/integrations/{integrationId}/events/replay endpoint was added

Changed Use case responses now include required top-level fields: id, name, type, enabled, integrationId, created_at, updated_at

December 14, 2025

Data Management API

Breaking Schedule schema simplified from daily/weekly/monthly variants to a single interval-based schedule with frequency and interval_days

December 12, 2025

Customer Portal API

New New assignment_mode field was added to contract identification hook configuration

New New EntityMatchingConfig was added to SSO identity provider configuration

Product API

Changed tax field on Price changed from an untyped schema to a BaseRelation reference

Changed $relation fields on coupon, price, product, and tax resources are now required

December 11, 2025

Workflows Execution API

New New DELETE /v2/flows/executions/{execution_id}/tasks/{task_id}/schedule endpoint was added to cancel scheduled tasks

Tax Entity

Changed rate property type changed from string to number

December 10, 2025

File API

Changed Multiple deprecated folder and collection endpoints were removed