Skip to main content

API Changelog

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

2026-07-31 Workflows Definition API

  • New optional keep_task_automations_in_sync field added to flow templates, accepted on POST/PUT /v2/flows/templates/{flowId} and returned by the template read, list, search, and duplicate endpoints

2026-07-31 Workflows Execution API

  • New POST /v2/flows/executions:portal-search-batch endpoint added for running several portal execution searches in one request; the request body takes a required entities array (the entity_ids and entity_schema fields it briefly accepted are no longer part of it)

2026-07-30 Blueprint API

  • New POST /v3/blueprint-manifest/blueprints:pre-install endpoint added for checking what a blueprint installation would do before actually starting it

2026-07-30 Journey Config API

  • The journey settings.savingProgress fields were renamed: savingMode is now mode and supportedVersion is now supportedRevision. The old names are no longer accepted on POST/PUT /v1/journey/configuration and are no longer returned by the v1 journey configuration endpoints (breaking)
  • settings.savingProgress is now also supported on the v2 journey configuration endpoints — accepted by POST/PUT /v2/journey/configuration and returned by GET /v2/journey/configuration/{id} and the v2 create, update, and patch responses

2026-07-30 Pricing API

  • New optional fields request property added to POST /v1/catalog and POST /v1/public/catalog, limiting the catalog response to the listed fields

2026-07-30 User API

  • New optional totp_enabled field added to users, showing whether two-factor authentication is set up for a user; it is returned by the user and group read endpoints (GET /v2/users, /v2/users/me, /v2/users/{id}, /v2/users/{id}/groups, the invite endpoints, and the /v1/groups endpoints) and can be set to false via PATCH /v2/users/{id} to turn two-factor authentication off for that user

2026-07-29 Workflows Execution API

  • New POST /v2/flows/executions:portal-search endpoint added for searching flow executions exposed to the customer portal; the request requires an audience field, which accepts all alongside the individual audience values

2026-07-28 Entity API

  • New POST /v1/entity:abortImport endpoint added for aborting an entity import that is still running

2026-07-27 App API

  • New optional change_mode and delete_contact fields added to portal extension hook configuration — settable via POST/PATCH /v1/app-configurations/{appId}/versions/{version}/components and returned by the app, app-configuration, and public component read endpoints

2026-07-27 Blueprint API

  • Blueprints can now carry notes: new POST /v2/blueprint-manifest/blueprints/{blueprint_id}/notes, PATCH /v2/blueprint-manifest/blueprints/{blueprint_id}/notes/{note_id}, and DELETE /v2/blueprint-manifest/blueprints/{blueprint_id}/notes/{note_id} endpoints added for adding, editing, and removing a note, and a notes field is now accepted when creating or updating a blueprint (POST/PUT /v2/blueprint-manifest/blueprints) and returned on the blueprint read, list, create, update, and delete responses; each note also carries an updated_at timestamp
  • New optional sync_notes install option added to POST /v2/blueprint-manifest/blueprint:install, POST /v3/blueprint-manifest/blueprint:install, POST /v3/blueprint-manifest/bulk-installs, and POST /v2/blueprint-manifest/jobs/{job_id}:continue, controlling whether blueprint notes are carried over during installation

2026-07-27 Integration Toolkit API

  • Passing group_id on events is now supported for parallelization within a batch of events in POST /v3/erp/updates/events
  • POST /v1/integrations/{integrationId}/events/replay responses now always include replayed and results, reporting how many events were replayed and the outcome for each one

2026-07-26 Blueprint API

  • New POST /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:health-check and GET /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/health-report endpoints added for starting a health check on a blueprint deployment and reading the resulting health report

2026-07-26 Email Settings API

  • New endpoints added for managing custom SMTP connections: GET/POST /v2/smtp/connections for listing and creating connections, GET/PUT/DELETE /v2/smtp/connections/{connectionId} for reading, updating, and removing a single connection, and POST /v2/smtp/connections/{connectionId}/test for verifying that a connection works
  • New endpoints added for managing the sender addresses used with those connections: GET/POST /v2/smtp/senders for listing and adding senders, and DELETE /v2/smtp/senders/{email} for removing one

2026-07-25 Integration Toolkit API

  • New POST /v2/integrations/{integrationId}/monitoring/external-events and GET /v2/integrations/{integrationId}/monitoring/traces/{correlationId} endpoints added for reporting externally-observed events into integration monitoring and for reading the full trace belonging to one correlation ID
  • New optional correlation_id field added to ERP update events (POST /v1/erp/updates/events and POST /v2/erp/updates/events) and returned for each event on POST /v1/integrations/{integrationId}/events, letting an event be tied to a monitoring trace

2026-07-24 Integration Previous Provider API

  • New GET /v2/integration/{type}/providers endpoint added, listing the available previous providers for a given integration type

2026-07-22 Message API

  • New optional inbox_id field added to POST /v1/message/threads:searchIds, limiting the returned thread IDs to threads in that inbox

2026-07-22 Metering API

  • New POST /v2/metering/readings/prune endpoint added for removing meter readings

2026-07-21 Notification API

  • New optional allowed_channels field (email, in_app) added when creating notifications and returned on notification reads; it caps which delivery channels a notification may use, with actual delivery being the intersection of this list and each recipient's own channel preferences (an empty array suppresses all delivery)

2026-07-16 Entity API

  • Entity data can now be returned with PII removed: an optional anonymize query parameter was added to the entity read endpoints (GET /v1/entity/{slug}/{id} and its v2/v3 variants, plus the activity, changesets, relations, /v1/entity/activity/{id}, and /v1/entity:autocomplete operations), and an optional anonymize request-body flag was added to POST /v1/entity:search, :list, and :export; when true, identifiers such as names, emails, phone numbers, and IBANs are replaced with deterministic pseudonyms (anonymization is forced regardless of the flag when the access token was created with anonymize: true)
  • New optional data_classification field (pii or public) added to every entity schema attribute type — returned by the schema endpoints and settable via POST /v1/entity/schemas/attributes — where pii always anonymizes the attribute value in anonymized responses and public never does, overriding the built-in defaults

2026-07-16 File API

  • New GET /v1/files/{id}/text endpoint added, returning the plain-text representation of a file entity (FileText); its status is ready (text available), not_ready while the text is still being prepared, or unsupported when text is unavailable for the file or organization

2026-07-15 Access Token API

  • New optional anonymize flag added when creating access tokens (POST /v1/access-tokens, including the app-token and assume-token variants); when true, all entity data returned to the token is PII-anonymized and the bearer cannot turn it off — the flag is also returned on token list, create, and delete responses

2026-07-15 Blueprint API

  • New POST /v3/blueprint-manifest/blueprints/{blueprint_id}:publish endpoint added for starting an asynchronous V3 blueprint publication

2026-07-15 Customer Portal API

  • New POST /v2/portal/contract/{id}/resolve-templates endpoint added — a POST variant of get-contract that accepts Handlebars templates and returns their resolved output per related meter (templates_output)

2026-07-15 Journey Config API

  • POST /v1/journey/document:generate now accepts an optional context_entity_id, resolving entity and relational template variables against that entity when generating the document

2026-07-14 Message API

  • New POST /v2/message/threads:workload endpoint added, returning the number of open threads assigned directly to each of up to 100 requested users (matching their central-inbox open view) for use in assignment load-balancing