Skip to main content

API Changelog

Breaking changes, new features, and significant updates to epilot APIs. Subscribe via RSS

2026-04-30 Integration Toolkit API

  • slug request property is now required on all use-case create variants (POST /v1/integrations/{integrationId}/use-cases) — file proxy, inbound, managed call, outbound, and secure proxy (breaking)
  • New optional allowed_origins array field added to FileProxy use case configuration, listing additional origins permitted to call /download (CORS); portal origins remain always allowed

2026-04-30 Journey Config API

  • New optional version query parameter added to GET /v1/journey/configuration/{id} and GET /v2/journey/configuration/{id} for fetching historical snapshots; 0 (default) returns the live row, positive integers return earlier saved versions
  • New optional settings.isActive boolean field added to journey configurations

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: _each (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 Pricing API

  • context.contract.billing_account and context.contract.payment request fields on POST /v1/public/external-catalog/products and POST /v1/public/external-catalog/product-recommendations changed from string relation IDs to objects (breaking)
  • context.contract.branch enum constraint removed on the same endpoints; the field now accepts any string instead of only the previous fixed values (power, gas, water, waste_water, district_heating)

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 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 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