CHANGELOG.md

API Changelog

This changelog covers breaking changes, new features, and significant updates to epilot's public APIs, including REST APIs, core entities, and core events.

2026-04-28 App API

• New block_reference component arg type added for Journey Block Components, allowing a block's arg to reference another block in the journey by ID; a new BlockReferenceArg schema supports an optional allowed_types filter

2026-04-28 Entity API

• New optional edit_mode and edit_mode_config fields added to all entity schema attribute types in schema responses
• _changesets field now included on entity objects returned from activity log responses

2026-04-28 Notes API

• created_by field type changed from a single object to an array of objects across all note endpoints — consumers reading created_by fields must handle arrays (breaking)
• New optional edited_at timestamp field added to notes and comments
• POST /v1/notes:search now requires at least one entry in the contexts array; previously empty arrays were silently accepted (breaking)
• New optional include_related_schemas array field added to note search requests for including notes on related entity schemas

2026-04-28 Entity Mapping API

• New iteration operations added to entity mapping rules: _foreach (path to the source array to iterate), _as (variable name for each item, accessed as $<name> in _copy paths within _map), and _map (operation applied per iteration item), enabling array-to-array entity transformation

2026-04-28 Webhooks API

• Webhook auth credential fields (password, clientSecret, keyValue) are now nullable; passing null explicitly clears the stored value, omitting the field preserves the existing value
• New optional apply_changesets boolean field added to webhook payloadConfiguration; when true, entity fields in the webhook payload reflect proposed changeset values instead of current persisted values

2026-04-21 Core Events

• New remarks array field added to MeterReadingAdded and ServiceMeterReadingAdded events, containing free-text remarks from the submitter in reading order (one per counter for multi-counter meters; empty or whitespace-only remarks are omitted)
• New remark field added to individual counter reading items within ServiceMeterReadingAdded

2026-04-17 Permissions API

• New equals_current_user grant condition (EqualsCurrentUserCondition) added, checking whether any relation_user attribute on the entity contains the currently authenticated user; an optional attribute path restricts the check to a specific field
• New optional vendor_created boolean field added to user, partner, and sharing role responses, indicating the role was created by a vendor organization on behalf of a partner organization

2026-04-16 Design Builder API

• Many new design token fields added to Journey design objects for fine-grained styling: button variants (primary, ghost, outlined), input fields, cards, chips, dropdowns, datepicker, toggles, topbar, font size scale, and more; IMAGE added as a new file_type option for design logos

2026-04-16 Integration Toolkit API

• New optional group_id field on POST /v3/erp/updates/events for controlling processing parallelism: events sharing the same group_id are processed in order; events with different group_id values are processed concurrently (up to 20 concurrent groups per integration)

2026-04-16 Message API

• New optional unlink_mapped_entities query parameter on POST /v1/message/threads/{id}/unassign; when true, also removes the unassigned entities from mapped_entities on related source entities

2026-04-16 Event: Meter Reading Added

• New contracts array field added to the MeterReadingAdded event payload, providing the full list of hydrated contract entities linked to the meter (supports meters associated with multiple contracts)

2026-04-15 Customer Portal API

• New POST /v2/portal/metering/readings endpoint added for retrieving paginated meter readings for a specific counter, with optional Handlebars template resolution per reading and per counter entity

2026-04-14 Customer Portal API

• New aggregation_method field added to consumption items in GET /v2/portal/consumption responses, indicating the aggregation method used (values: sum, average, max, min)
• New POST /v3/portal/config/clone endpoint added for cloning a portal configuration (including pages, settings, email templates, and authentication) from an existing portal

2026-04-14 Environments API

• New endpoints added for managing environment variable groups: GET /v1/environments/groups (list groups), PUT /v1/environments/groups/{name} (create or update a group), DELETE /v1/environments/groups/{name} (delete a group)
• New optional group and protected fields added to environment variables across all endpoints; group assigns a variable to a named group, protected marks a variable as read-only

2026-04-13 Blueprint Manifest API

• New GET /v1/marketplace-listings endpoint added for listing all marketplace listings for the authenticated organization
• documentation_link field removed from marketplace listing responses and request bodies

2026-04-13 Email Settings API

• New POST /v1/email-settings/domain/dns-records:verify endpoint added for verifying that all DNS records (MX, TXT, CNAME) are correctly configured for a domain
• POST /v1/email-settings/domain/ns-records:verify is now deprecated — use the new endpoint for new integrations

2026-04-13 User API

• New image_uri field added to user groups, supporting profile image URLs and gradient avatar color configuration

2026-04-10 Deduplication API

• New asynchronous deduplication endpoints: POST /v1/deduplicate/job submits a background job and returns a jobId; GET /v1/deduplicate/jobs/{jobId} returns the current job status and result

2026-04-10 Journey Config API

• New optional protectedEditable array field added to journey configurations, listing path patterns (with wildcard support) that remain editable when the journey is in protected (read-only) mode

2026-04-09 Automation API

• New ForwardEmailAction and ReplyEmailAction action types added to automation flows and executions, enabling automated email forwarding and reply workflows
• New reply_to_sender, reply_mode (reply_in_thread or new_email), and mark_as_done fields added to SendEmailAction configuration

2026-04-09 Integration Toolkit API

• New group_by request field added to POST /v2/integrations/{integrationId}/monitoring/time-series, enabling breakdown of time-series buckets by use_case_type or use_case
• New breakdown array returned in each time-series bucket when group_by is specified

2026-04-09 Workflows Definition API

• New input_entity field added to AutomationTrigger for email thread triggers, specifying which entity (thread, first_email, or last_email) is used as input for automation and decision tasks

2026-04-08 Blueprint Manifest API

• New POST /v3/blueprint-manifest/blueprint:install endpoint added for installing blueprints using the V3 engine (direct API calls with checkpoint-based resume on failure)
• New GET /v3/blueprint-manifest/blueprints/{blueprint_id}/lineage endpoint added for retrieving lineage registry entries mapping source IDs to destination resource IDs
• New PARTIAL_SUCCESS status value added to blueprint installation job responses

2026-04-08 Webhooks API

• New POST /v1/webhooks/configs/{configId}/test-oauth endpoint added for testing the OAuth client credentials configuration of a webhook
• New deliveryMode field added to webhook configurations (json_base64 or binary_multipart) to control how file data is delivered for file-triggered webhooks
• New multipartConfig field added for specifying form field names when using binary_multipart delivery mode

2026-04-07 File API

• GET /v1/files/{id}/public-links and DELETE /v1/files/{id}/public-links/{linkId} endpoints are now implemented — listing and revoking public file links is now available

2026-04-06 Event: FileCreated

• New FileCreated event type added with required fields: entity_id, filename, mime_type, size_bytes, s3ref, version_index; includes an embedded file entity object with file metadata and a category field

2026-04-03 Email Settings API

• New GET /v1/email-settings/domain endpoint added for retrieving all custom email domains configured for the organization

2026-04-02 Scheduler API

• New scheduled_at_from and scheduled_at_to date-time filter fields added to POST /v1/schedules:search for filtering schedules by time window
• New sort direction field added to schedule search requests (values: asc, desc; default: asc)

2026-04-01 Automation API

• New optional target_workflow query parameter added to GET /v1/automation/flows — filters automations to those targeting a specific workflow by ID

2026-04-01 Customer Portal API

• Deprecated POST /v2/portal/public/user (portal user creation endpoint)
• New GET /v3/portal/public/schemas endpoint added for retrieving entity schemas in the portal context
• New GET /v3/portal/public/widgets endpoint added as the v3 replacement for GET /v2/portal/public-widgets

2026-04-01 Kanban API

• New task enum value added to group_by.field on Kanban boards (alongside existing context_entity and phase)

2026-04-01 Organization API

• New GET /v2/organization/feature-settings endpoint added for retrieving feature flag metadata for the organization UI

2026-03-31 Customer Portal API

• New search_snippets and templates_output_highlighted optional fields added to entity search responses, providing highlighted text snippets for matched fields
• New highlight boolean option added to entity search requests to enable search result highlighting

2026-03-31 Integration Toolkit API

• New monitoring v2 endpoints: POST /v2/integrations/{integrationId}/monitoring/events, POST /v2/integrations/{integrationId}/monitoring/stats, POST /v2/integrations/{integrationId}/monitoring/time-series, GET /v2/integrations/{integrationId}/monitoring/events/{eventId}/associated
• New type generation endpoints: POST /v1/integrations/{integrationId}/generate-types-preview, POST /v1/integrations/{integrationId}/generate-types, POST /v1/integrations/{integrationId}/commit-types — for generating and committing TypeScript type definitions from managed call use cases
• New type_annotations and types_locked fields added to managed call use cases

2026-03-31 Message API

• New spam management endpoints added: POST /v1/message/messages/{id}/spam, POST /v1/message/messages/{id}/unspam, POST /v1/message/threads/{id}/spam, POST /v1/message/threads/{id}/unspam
• New spam count field added to the GET /v1/message/messages/unread/{actor} response

2026-03-30 Entity API

• New exclude_types query parameter added to the taxonomy classification search endpoint, allowing specific entity types to be excluded from results

2026-03-30 Workflows Definition API

• New partner optional field added to workflow steps (v1 definitions) and tasks (v2 flow templates), providing partner-specific task display details (enabled, label, description) for partner org users

2026-03-27 App API

• New GET /v1/public/app/{appId}/proxy/{proxyName}/{path} and POST /v1/public/app/{appId}/proxy/{proxyName}/{path} endpoints added for routing requests through a named API proxy configured on the app

2026-03-25 Entity API

• New POST /v1/entity/schemas/{slug}/freeze and POST /v1/entity/schemas/{slug}/unfreeze endpoints added for managing schema version lifecycle
• New frozen and latest boolean fields added to schema responses; draft field is now deprecated
• New frozen_version field added to schema versions response; unpublished query parameter deprecated in favour of the new latest parameter

2026-03-25 Workflows Execution API

• New POST /v2/flows/executions/{execution_id}/tasks/{task_id}/schedule/run-now endpoint added — cancels the pending schedule for a task and immediately triggers its automation execution

2026-03-24 Customer Portal API

• New GET /v3/portal/widgets and POST /v3/portal/widgets endpoints added for managing portal widgets (v3)
• New POST /v3/portal/portal/files endpoint added for uploading files in the portal context

2026-03-24 Email Settings API

• New MS Teams channel endpoints added: POST /v2/channels/msteams/connect, POST /v2/channels/msteams/disconnect, GET /v2/channels/msteams/status
• New teams_enabled boolean field added to the Outlook connection status response

2026-03-24 Kanban API

• New group_by field added to Kanban board configuration, enabling tasks to be grouped within each swimlane; supports context_entity, phase, and task grouping options
• New group_by field added to POST /v1/kanban/query/flows:execute request for grouping task query results

2026-03-23 Customer Portal API

• New domain parameter accepted as an alternative to portal_id across most public portal endpoints, allowing portal identification by domain name
• New portal_id field added to portal page objects in responses

2026-03-19 Event: InvoiceSimulationRequested

• New meter entity object added to the event payload, containing meter details associated with the simulation request

2026-03-18 App API

• New optional secure_proxy field added to all portal extension hook types (via PortalExtensionSecureProxy schema), routing hook HTTP requests through a VPC secure proxy

2026-03-18 Customer Portal API

• New portal_id parameter added to the admin login-as-user endpoint
• New evaluate_targeting boolean field added to the page interpolation request
• Deprecated endpoints: GET /v2/portal/contract, POST /v2/portal/opportunities/search, GET /v2/portal/opportunities/searchable-attributes, GET /v2/portal/opportunity, GET /v2/portal/order, GET /v2/portal/request

2026-03-18 Workflows Definition API

• max_iterations maximum for decision task loop configuration increased from 10 to 100

2026-03-16 Entity API

• New GET /v2/entity/schemas endpoint added, supporting full, unpublished, exclude, and include query parameters for flexible schema retrieval
• New include filter parameter added to GET /v1/entity/schemas
• New _summary boolean field added to schema response objects, indicating whether the schema is returned as a truncated summary

2026-03-16 ERP Integration API

• New secure_proxy use case type introduced across all use-case endpoints
• New GET /v1/integrations/secure-proxies endpoint lists all secure proxy use cases across integrations
• New POST /v1/secure-proxy endpoint proxies HTTP requests through a VPC tunnel using a configured secure proxy use case

2026-03-16 Webhooks API

• New optional secureProxy object added to webhook configuration — routes webhook HTTP requests through the VPC secure proxy; requires integration_id and use_case_slug referencing a configured ERP integration secure proxy use case

2026-03-12 Blueprint Manifest API

• New POST /v2/blueprint-manifest/blueprints:publish endpoint added for publishing a blueprint to the marketplace
• New GET /v2/blueprint-manifest/marketplace/slugs endpoint added for listing available marketplace slugs from the Webflow CMS

2026-03-12 Event: InvoiceSimulationRequested

• New InvoiceSimulationRequested event type introduced with fields: meter_reading_value, meter_reading_date, customer_number, debitor_number, billing_group, and an embedded contract entity reference

2026-03-11 Access Token API

• New portal_preview token type added, enabling tokens scoped for portal preview sessions
• New portal_user_id field added to AccessTokenItem responses

2026-03-11 Pricing API

• Breaking: Several fields in ExternalCatalogPortalRequest contract context changed type: installment_amount changed from {value, currency} object to number; balance changed from {value, currency} object to number; customer changed from an array to a single object; delivery_address changed from a single object to an array

2026-03-11 Submission API

• POST /v1/submission/submissions now returns a response body containing a submission_id string (previously returned 201 Created with no body)
• Error responses (400, 401, 403, 500) are now documented for the submission creation endpoint

2026-03-10 Billing Event Entity

• New invoice_number string field added to the billing_event entity schema

2026-03-09 Message API

• New POST /v1/message/threads/bulk:move endpoint added for moving multiple threads to a different inbox in a single request
• New POST /v1/message/threads/bulk:assign endpoint added for bulk-assigning multiple threads
• New optional assign_to and inbox_id fields added to the bulk read/unread request payload

2026-03-07 GenAI API

• New POST /v1/genai/search/query:generate endpoint added — generates an AI-optimized Elasticsearch Lucene query from natural language input; accepts input, schemas, and locale in the request; returns query, confidence, and intent in the response

2026-03-05 ERP Integration API

• New oauth2_password auth type added to file proxy use case authentication configuration, with username and password credential fields

2026-03-04 File API

• New optional version_only query parameter added to POST /v1/files and POST /v2/files — when true, creates a new file version without overwriting top-level entity metadata
• POST /v2/files now accepts an array of up to 20 BatchSaveFileVersionPayload objects when version_only=true, enabling batch version saves in a single request

2026-03-03 Customer Portal API

• New PRODUCT_RECOMMENDATIONS_WIDGET widget type was added; the new ProductRecommendationsWidget schema (extending TeaserWidget with a campaign_id field) is now available across the GET /v2/portal/widgets, GET /v2/portal/public-widgets, and POST /v2/portal/widgets endpoints

2026-03-03 Pricing API External Catalog

• Breaking: The catalog_type enum values on POST /integration/external-service were renamed: products → product and products-recommendation → product-recommendations; the corresponding response schema was also renamed from ExternalCatalogProductsRecommendationResponse to ExternalCatalogProductRecommendationsResponse
• Breaking: The POST /v1/public/integration/{integrationId}/products-recommendation and POST /v1/public/external-catalog/products-recommendation endpoints were renamed to product-recommendations; new endpoints at the updated paths are now available
• Breaking: The coupons field in external catalog responses changed from an array to a single object
• New optional before_discount_amount_subtotal fields added to pricing line item responses
• postal_code is no longer a required field in availability filter requests

2026-03-03 Message API

• New GET /v1/message/messages/{id}/eml endpoint was added, returning a 302 redirect to a pre-signed URL for downloading the message as an EML file
• New optional complete_thread field was added to message creation and draft endpoints (POST /v1/message/messages, POST /v1/message/drafts), marking the thread as Done immediately after the message is sent

2026-03-02 Blueprint Manifest API

• New POST /v2/blueprint-manifest/blueprints/{blueprint_id}:format-description endpoint was added, which formats a blueprint description as markdown using AI (accepts a text field, returns markdown)
• Breaking: compatible_apps field was removed from MarketplaceBlueprint and replaced by recommended_apps across all blueprint endpoints
• New optional fields docs_url, recommended_apps, required_features, and zip_file_name were added to all blueprint types (AppBlueprint, CustomBlueprint, DeployedBlueprint, FileBlueprint, MarketplaceBlueprint)

2026-03-02 Workflows Definition API

• New GET /v2/flows/templates/{flowId}/export endpoint was added, exporting a flow template with all referenced automations resolved and bundled
• New POST /v2/flows/templates/import endpoint was added, importing a flow template from an export payload and creating all referenced automations in the caller's organization
• Two new due_date_config/type enum values were added to flow templates: A_PRECEDING_TASK_COMPLETED and ALL_PRECEDING_TASKS_COMPLETED, enabling task and phase due dates to be relative to predecessor task completion; affects all /v2/flows/templates endpoints

2026-02-27 Workflows Execution API

• The assigned_to field on executions, phases, and tasks now accepts variable assignment objects ({ variable, value }) in addition to plain user ID strings, enabling dynamic assignee resolution during workflow execution; affects POST /v2/flows/executions, GET and PATCH /v2/flows/executions/{execution_id}, PATCH /v2/flows/executions/{execution_id}/phases/{phase_id}, and task creation/update endpoints

2026-02-26 User API

• New passkey authentication and management endpoints were added: POST /v2/users/public/passkeys:authenticateBegin and :authenticateBeginDiscoverable start a WebAuthn authentication flow; POST /v2/users/public/passkeys:resolveCredential resolves user identity from a discoverable assertion; POST /v2/users/me/passkeys:registerBegin and :registerComplete handle passkey registration; GET /v2/users/me/passkeys lists registered passkeys; DELETE /v2/users/me/passkeys/{credentialId} removes a passkey
• New passkey_enabled boolean field was added to LoginParameters responses, indicating whether passkey login is available for the organization

2026-02-26 ERP Integration API

• Breaking: The requires_vpc field in File Proxy use-case configuration is now read-only after creation — it can no longer be set or updated via the API; affects POST /v1/integrations/{integrationId}/use-cases, PUT /v1/integrations/{integrationId}/use-cases/{useCaseId}, and their v2 equivalents

2026-02-26 Workflows Definition API

• PhaseMarkedInProgress and PhaseSkipped entity sync trigger event values were re-added to flow templates (reverting the 2026-02-23 removal) — affects all /v2/flows/templates endpoints

2026-02-26 Workflows Execution API

• PhaseMarkedInProgress and PhaseSkipped entity sync trigger event values were re-added to execution responses (reverting the 2026-02-23 removal); TaskMarkedOnHold entity sync trigger event value was also added — affects POST /v2/flows/executions, GET /v2/flows/executions/{execution_id}, PATCH /v2/flows/executions/{execution_id}, and POST /v2/flows/executions:search

2026-02-25 Access Token API

• New last_used field was added to access token responses, indicating the date the token was last used (YYYY-MM-DD format, 1-day accuracy); available in GET /v1/access-tokens, POST /v1/access-tokens, and DELETE /v1/access-tokens/{id} responses

2026-02-25 Billing API

• Breaking: booking_date (date) is now a required field when creating or updating billing events — affects POST /v1/billing/events and PATCH /v1/billing/events/{id}
• Breaking: due_date on InstallmentEvent changed from date-time to date format
• Six new billing event types were added to the BillingEvent union: payment, dunning_fee, final_bill, bonus, correction, and custom — clients parsing event responses should handle these new variants
• New optional fields were added to all billing event types: direction (debit/credit), status (open/closed), related_event, external_link, attachments, note, and internal_note

2026-02-25 App API

• New CUSTOM_PAGE app component type was added — the new CustomPageComponent schema includes a required slug field (URL route, e.g. "zapier") and optional nav_label, nav_icon, and nav_description navigation fields; supported across all app and app-configuration endpoints

2026-02-25 GenAI API

• New POST /v1/genai/entity/{slug}/{entity_id}/summary endpoint was added to generate AI summaries for entities, streaming the response via text/event-stream; supports optional language (de/en), variant (short/detailed/action_points), and current_summary parameters

2026-02-25 Workflows Definition API

• Automation triggers and tasks in flow templates now support inline configuration: new optional trigger_config array on AutomationTrigger and new optional action_config object on AutomationTask.automation_config allow automation flows to be created or updated in place without a pre-existing ID — automation_id on triggers and flow_id on automation configs are now optional; affects all /v2/flows/templates endpoints

2026-02-24 ERP Integration API

• Breaking: payload field on event update endpoints now enforces stricter validation — string payloads require minLength: 2 and object payloads require minProperties: 1; affects POST /v1/erp/updates/events, POST /v2/erp/updates/events, and POST /v3/erp/updates/events
• New warnings array was added to mapping simulation responses (POST /v1/erp/updates/mapping_simulation, POST /v2/erp/updates/mapping_simulation), reporting validation issues about the configuration such as unique ID fields referencing non-indexed attributes

2026-02-23 Message API

• New POST /v2/message/threads/{id}/assign:users endpoint was added, allowing users to be added or removed from a message thread

2026-02-23 Workflows Execution API

• PhaseMarkedInProgress and PhaseSkipped enum values were removed from the trigger/event field in entity sync responses — affects POST /v2/flows/executions, GET /v2/flows/executions/{execution_id}, PATCH /v2/flows/executions/{execution_id}, and POST /v2/flows/executions:search

2026-02-23 Workflows Definition API

• PhaseMarkedInProgress and PhaseSkipped enum values were removed from the entity_sync/trigger/event field across all flow template endpoints — affects request body of POST and PUT /v2/flows/templates/{flowId}, and responses of GET, POST, PUT /v2/flows/templates, POST /v2/flows/templates:search
• New TaskMarkedOnHold trigger event value was added to entity_sync/trigger/event, enabling entity sync rules to fire when a task is placed on hold

2026-02-23 Customer Portal API

• New allowed_portal_entities field was added to portal config request and response schemas — accepts an array of entity slugs (e.g., contact, contract) to restrict which entity types are accessible in the portal; available across all v2 and v3 portal config endpoints

2026-02-23 Automation API

• New assign-thread automation action type was added — AssignThreadAction and AssignThreadConfig schemas allow automations to add or remove assignees from message threads

2026-02-23 Meter Entity

• New me_lo_id field was added for storing the MeLo-ID (Messlokation) measurement location identifier

2026-02-22 Blueprint Manifest API

• New optional archived query parameter was added to GET /v2/blueprint-manifest/blueprints to filter by archived status
• New optional archived field was added to blueprint objects, indicating whether a blueprint is soft-deleted and hidden from the main list

2026-02-22 Entity API

• New table schema attribute type was added

2026-02-20 ERP Integration API

• Integration create/update/get response schemas restructured — fields now composed via allOf[IntegrationEditableFields]; SDK consumers should regenerate types
• settings.autoRefresh.minIntervalBetweenSyncsMinutes was removed from integration settings

2026-02-20 Core Events

• New TariffChange event was introduced
• New OrderSubmission event was introduced

2026-02-19 ERP Integration API

• New file_proxy use case type was added — FileProxyUseCase is now a valid variant alongside InboundUseCase/OutboundUseCase
• New optional settings object was added to integration create/update/get endpoints

2026-02-19 Webhooks API

• New filterConditions field was added to webhook configs, allowing event delivery to be filtered by conditions

2026-02-18 Customer Portal API

• New EntitySlugConfig support was added to entity search — accepts per-slug configuration objects with slug, targets, and templates
• New include parameter was added to entity search to side-load enrichment data (supports active_workflow)
• New advanced_authentication and timeouts settings were added to cognito config
• New show_in_navigation field was added to page configuration

2026-02-18 Workflows Definition API

• assigned_to field type changed from plain string to oneOf[string, VariableAssignment] — unlocks dynamic variable-based assignment

2026-02-18 Metering API

• POST /v2/metering/readings request now uses a discriminated union on the operation field (CreateOrUpdateBatchReading or DeleteBatchReading)

2026-02-13 Workflows Definition API

• New additional_triggers field was added to flow templates, enabling multiple trigger configurations per flow

2026-02-12 ERP Integration API

• New POST /v1/integrations/{integrationId}/monitoring/timeseries endpoint was added for querying time-series event counts

2026-02-11 ERP Integration API

• POST /v1/erp/updates/events (v1) and POST /v2/erp/updates/events (v2) are now deprecated — migrate to POST /v3/erp/updates/events
• New ignored and warning status values were added to event processing and monitoring responses

2026-02-11 Webhooks API

• GET /v1/webhooks/.well-known/public-key endpoint was reactivated with a new required orgId query parameter

2026-02-10 ERP Integration API

• New POST /v3/erp/updates/events endpoint was added — v3 event processing using integration-based authentication
• Breaking: reverse-relations was removed from scope_mode enum in inbound use case entity scope

2026-02-10 Webhooks API

• New signingSecret field was added to webhook config responses (returned once at creation time)

2026-02-09 Email Settings API

• New GET /v2/outlook/connection:resolve endpoint was added to look up an Outlook connection by email address

2026-02-06 Entity API

• Breaking: POST /v1/entity/taxonomies/{taxonomySlug}/classifications — deleted response type changed from object to array

2026-02-06 Customer Portal API

• New GET /v2/portal/entity/{slug}/{id}/workflows endpoint was added

2026-02-06 Order Entity

• New coupons relation was added

2026-02-05 Pricing API

• New coupons field was added to order responses
• New portal origin type was added to external catalog requests
• New PortalContext was added as a valid context type for external catalog integration requests

2026-02-05 Automation API

• New NewEmailThreadTrigger trigger type was added to automation flows

2026-02-05 Query API

• New GET /v2/query/semantic-model endpoint was added, returning available entity tables, relationships, and query capabilities

2026-02-05 Contract Entity

• New assets relation was added

2026-02-05 Order Entity

• New opportunities and contracts relations were added

2026-02-04 Entity API

• New exclude query parameter was added to GET /v1/entity/schemas for excluding schemas by slug
• POST /v1/entity:graph now returns null for cardinality="one" nodes when no entity is found

2026-02-04 Customer Portal API

• New PUT /v2/portal/notifications/entity:status endpoint was added for batch-updating notification status

2026-02-03 Webhooks API

• New NONE auth type was added, allowing webhook endpoints using standard signature auth only

2026-02-03 Core Events

• New OnDemandSyncContractRequested event was introduced
• New OnDemandSyncCustomerRequested event was introduced
• MeterReadingAdded event payload restructured — single reading_value/obis_number/direction fields replaced by meter_readings array supporting multiple counters per submission

2026-01-30 ERP Integration API

• Monitoring endpoints split — POST .../monitoring/events replaced by separate POST .../monitoring/inbound-events and POST .../monitoring/outbound-events endpoints
• Monitoring stats response restructured — flat fields replaced by inbound and outbound sub-objects

2026-01-30 Customer Portal API

• New GET /v2/portal/metering/reading/allowed-range/{meter_id} endpoint was added

2026-01-30 Core Events

• New required _ack_id field was added to all event payloads for delivery acknowledgement tracking

2026-01-29 Partner Directory API

• New POST /v2/partners/{orgId}/roles and PUT /v2/partners/{orgId}/roles/{roleId} endpoints were added for partner role management

2026-01-28 ERP Integration API

• New GET /v1/integrations/{integrationId}/outbound-status endpoint was added
• event_catalog_event and mappings are now required fields on OutboundUseCase configuration

2026-01-27 ERP Integration API

• New POST /v1/integrations/{integrationId}/monitoring/access-logs endpoint was added for API access log analytics

2026-01-27 Workflows Definition API

• New message_email_address attribute type and attribute_sub_field were added to decision task conditions

2026-01-27 Event: Service Meter Reading Added

• Payload restructured — single reading fields replaced by meter_readings array; reason/note removed; counter_id, direction, status, reading_source added; meter_counter replaced by meter_counters array

2026-01-26 User API

• New POST /v2/user/navigations and GET /v2/user/navigations/{id} endpoints were added for navigation configurations

2026-01-23 ERP Integration API

• New POST .../monitoring/events and POST .../monitoring/stats endpoints were added for integration monitoring

2026-01-23 Email Settings API

• New Microsoft 365/Outlook integration endpoints were added: connect, disconnect, connection status, shared mailbox management, and OAuth callback

2026-01-23 Pricing API

• New POST /v1/public/external-catalog/products and POST /v1/public/external-catalog/products-recommendation public endpoints were added

2026-01-22 Automation API

• New TriggerEventAction action type was added for explicitly triggering event catalog events from automation flows

2026-01-22 Permissions API

• New parent_role field was added to user roles, allowing inheritance from a parent role

2026-01-22 Notification Template Entity

• New notification_template entity was introduced

2026-01-22 Core Events

• operation, activity_id, activity_type, and trigger_entity fields were removed from event payloads

2026-01-21 Workflows Execution API

• New AI_AGENT task type was added with AiAgentTask schema

2026-01-21 Core Events

• New _trigger_source_type and _trigger_source fields were added to all event payloads, identifying the system and source that triggered each event

2026-01-20 Notification API

• New POST /v1/notification/templates/send-preview endpoint was added

2026-01-16 Notification API

• New notification template CRUD endpoints were added: list, create, get, update, patch, and delete

2026-01-15 ERP Integration API

• New v2 integration endpoints were added: GET/PUT/DELETE /v2/integrations/{integrationId} — v2 integrations embed use cases directly in the response
• jsonataExpression in meter reading configuration is now optional (previously required)

2026-01-15 Core Events

• New CustomerDetailsUpdated event was introduced
• New ServiceMeterReadingAdded event was introduced

2026-01-14 Data Management API

• Breaking: related_entities_any_in_closed_or_cancelled_status filter type was removed

2026-01-12 Blueprint Manifest API

• New GET /v2/blueprint-manifest/blueprints:preview/{preview_id} endpoint was added
• Breaking: POST /v2/blueprint-manifest/blueprints:pre-install response changed from Blueprint to BlueprintPreview schema

2026-01-09 Customer Portal API

• 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

2026-01-09 Core Events

• New BillingAccountConnectionRemoved event was introduced
• New GeneralRequestCreated event was introduced
• New LocationMoveRequested event was introduced
• New TerminateContractRequested event was introduced

2026-01-08 Pricing API

• postal_code is now required in availability location filter objects

2026-01-08 Kanban API

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

2026-01-08 Metering API

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

2026-01-07 Data Management API

• New POST /data-management/v1/configs/{config_id}/jobs endpoint was added to manually trigger job runs
• New GET /data-management/v1/jobs/{job_id} endpoint was added
• New related_entities_workflows_only_in_closed_or_cancelled_status filter type was added

2025-12-31 Event Catalog API

• 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

2025-12-30 Customer Portal API

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

2025-12-30 Blueprint Manifest API

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

2025-12-30 Metering API

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

2025-12-26 Location Entity

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

2025-12-23 Pricing API

• New public external catalog endpoints were added for products and product recommendations
• External catalog context now supports CustomContext alongside JourneyContext

2025-12-22 Customer Portal API

• Breaking: Meter reading note field was renamed to remark
• New detail_schema field was added to page configuration

2025-12-19 Customer Portal API

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

2025-12-19 Data Management API

• New endpoints were added: get config by ID, list jobs with filtering, and job report download URL
• Breaking: lookback_period_months was replaced by lookback_period_days
• email entity type was replaced by message in relations_for_deletion

2025-12-18 Customer Portal API

• meter_id is now optional (deprecated) on consumption, costs, and prices endpoints
• New context_entities parameter was added as a replacement

2025-12-17 ERP Integration API

• New POST /v1/integrations/{integrationId}/events/replay endpoint was added
• Use case responses now include required top-level fields: id, name, type, enabled, integrationId, created_at, updated_at

2025-12-14 Data Management API

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

2025-12-12 Customer Portal API

• New assignment_mode field was added to contract identification hook configuration
• New EntityMatchingConfig was added to SSO identity provider configuration

2025-12-12 Product API

• tax field on Price changed from an untyped schema to a BaseRelation reference
• $relation fields on coupon, price, product, and tax resources are now required

2025-12-11 Workflows Execution API

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

2025-12-11 Tax Entity

• rate property type changed from string to number

2025-12-10 File API

• Multiple deprecated folder and collection endpoints were removed

2025-12-10 Email Template API

• New json_template field was added to template create, update, and response schemas

2025-12-10 Core Events

• New PaymentMethodUpdated event was introduced
• New BillingAddressUpdated event was introduced

2025-12-09 ERP Integration API

• New POST /v1/integrations/{integrationId}/events endpoint was added for querying integration events

2025-12-09 Core Events

• New InstallmentUpdated event was introduced
• New MeterReadingAdded event was introduced

2025-12-08 Data Management API

• New GET /data-management/v1/configs and POST /data-management/v1/{entity_schema}/configs endpoints were added

2025-12-08 IBAN API

• Breaking: IBAN validation endpoint moved from POST /v1/iban:validate to POST /v1/public/iban:validate

2025-12-05 ERP Integration API

• New POST /v2/erp/updates/mapping_simulation endpoint was added for v2 mapping format simulation
• New _append_all operation and relation_refs field were added to use case field configuration

2025-12-02 ERP Integration API

• Breaking: Use case create/update request body changed to a discriminated union (CreateInboundUseCaseRequest | CreateOutboundUseCaseRequest)
• New GET .../use-cases/{useCaseId}/history endpoint was added for use case configuration history

2025-12-02 Webhooks API

• New POST /v1/webhooks/configs/{configId}/events/replay-batch endpoint was added for batch event replay
• GET /v1/webhooks/configs/{configId}/events was deprecated

2025-12-01 ERP Integration API

• New POST /v2/erp/updates/events endpoint was added — v2 event processing using integration_id
• New PUT/DELETE /v1/integrations/{integrationId}/app-mapping endpoints were added
• UseCase schema split into InboundUseCase and OutboundUseCase discriminated variants

2025-11-30 Data Management API

• New POST /data-management/v1/{entity_schema}/query endpoint was added

2025-11-28 Template Variables API

• New POST /v2/template:replace endpoint was added, preserving original data types instead of stringifying

2025-11-27 Workflows Execution API

• New ON_HOLD status value was added to step and task status enum
• update_entity_attributes was replaced by entity_sync with a richer schema including typed trigger events

2025-11-26 Customer Portal API

• New POST /v3/portal/partner/{id}/disable and POST /v3/portal/partner/{id}/enable endpoints were added
• USER_ACCOUNT_SELF_MANAGEMENT was removed from self_registration_setting enum and replaced by a dedicated boolean

2025-11-26 Partner Directory API

• New partner user management endpoints were added: list users, create user, delete user, list roles, assign/unassign roles

2025-11-26 GenAI API

• New POST /v1/genai/erp/mapping:generate endpoint was added for AI-generated ERP mapping configurations

2025-11-25 File API

• New File Collections API was introduced with CRUD endpoints, replacing the deprecated File Folders API
• New slug-based collection endpoints were added alongside entity-based endpoints

2025-11-25 Pricing API

• New POST /v1/public/integration/{integrationId}/products-recommendation endpoint was added

2025-11-25 Pricing API External Catalog

• Breaking: catalog_type field is now required in the request context
• Response body changed from a plain array to a discriminated union based on catalog_type

2025-11-24 Entity API

• New POST /v1/entity:graph endpoint was added for traversing entity relationship graphs with configurable node schemas, edges, and cardinality

2025-11-23 Customer Portal API

• Breaking: app_id, hook_id, and extension_id fields are now required in extension hook configuration (previously optional)

2025-11-20 Portal User Entity

• New represents relation was added

2025-11-20 Contact Entity

• represents_contact relation was removed

2025-11-19 Pricing API

• days was added as a billing duration unit across all duration fields (billing, notice, renewal, termination)

2025-11-19 Ticket Entity

• title was renamed to ticket_title
• number was renamed to ticket_number

2025-11-19 Notes API

• created_by field changed from a plain string/number ID to a structured object with type, user_id, display_name, and other fields

2025-11-18 Workflows Execution API

• New revert_execution option was added to task patch — resets succeeding tasks to PENDING when updating a previous task

2025-11-17 Pricing API

• New reference_date parameter was added to compute-price requests
• tax field type changed from a free-form object to a Tax schema reference

2025-11-17 Webhooks API

• Three deprecated v1 failure endpoints were removed

2025-11-17 Journey Config API

• New logicsV4 field was added, supporting a more expressive logic rule format with per-rule IDs, conditions, actions, and settings

2025-11-14 ERP Integration API

• New Integration management CRUD endpoints were added: GET/POST/PUT/DELETE /v1/integrations
• New Use Case management CRUD endpoints were added: GET/POST/PUT/DELETE /v1/integrations/{id}/use-cases

2025-11-12 Asset Entity

• New asset entity was introduced with properties including title, serial number, manufacturer, model, maintenance dates, and relations to customer, contract, meter, and ticket

2025-11-10 ERP Integration API

• payload field in event processing and mapping simulation now accepts a JSON object directly (previously only serialised strings)

2025-11-10 Customer Portal API

• New partner management endpoints were added: invite, list, resend invitation, and revoke

2025-11-07 Customer Portal API

• New POST /v2/portal/entity:get endpoint was added for retrieving a single entity by ID

2025-11-06 Customer Portal API

• Breaking: Enum constraints on the schema field in page configuration were removed — now accepts any string slug

2025-11-06 Core Entities

• New external_id property was added to Contact, Contract, Billing Account, Meter, and Meter Counter entities

2025-11-06 Billing Account Entity

• billing_address field type changed from a relation reference to an inline address object
• payment_method items restructured to include a typed type enum and structured data object

2025-11-04 Email Settings API

• New GET /v2/email-settings/inbox-buckets endpoint was added

2025-11-03 Webhooks API

• New POST /v2/webhooks/configs/{configId}/events endpoint was added for listing and filtering webhook events

2025-10-31 Message API

• New POST /v1/message/threads/{id}:move endpoint was added for moving threads between inboxes

2025-10-30 ERP Integration API

• v2 mapping format support was added to mapping simulation with events mapping object
• Relation operation field restricted to enum values _set and _append

2025-10-29 Automation API

• New entity_exists and entity_does_not_exist condition operations were added

2025-10-22 ERP Integration API

• New POST /v1/erp/updates/mapping_simulation endpoint was added for dry-running payload transformations

2025-10-22 GenAI API

• New GET /v1/genai/entity/{slug}/{entity_id}/summary endpoint was added for retrieving AI-generated entity summaries

2025-10-17 ERP Integration API

• New deduplication_id field was added to event payloads for idempotency control
• New skipped status was added for deduplicated events

2025-10-15 Customer Portal API

• New GET /v2/portal/billing/accounts/{id} endpoint was added

2025-10-14 Customer Portal API

• Breaking: contracts and filters_schema were removed from entity search request; replaced by filters_context

2025-10-13 Blueprint Manifest API

• All v1 blueprint manifest endpoints were deprecated in favor of v2

2025-10-09 Workflows Definition API

• New JourneyAutomationTrigger was added for journey-based automation triggers on flow templates

2025-10-08 Customer Portal API

• Breaking: END_CUSTOMER_PORTAL and INSTALLER_PORTAL enum values were removed from the origin parameter — now accepts any string
• New POST /v3/portal/config/swap endpoint was added

2025-10-08 Email Settings API

• New email address management endpoints were added: list, create, get, update, delete, provision, and set primary