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

August 3, 2026

User API

New New optional passkeys_registered field added to LoginParameters responses, indicating whether the user already has a passkey registered — returned by GET /v1/users/username/{username}:getLoginParameters, GET /v2/users/public/username/{username}:getLoginParameters, and POST /v2/users/public/passkeys:resolveCredential

August 1, 2026

Integration Toolkit API

New New endpoints added for importing data from an ERP system: GET/POST /v2/erp/imports for listing and creating an import, GET /v2/erp/imports/{importId} for reading a single import, POST /v2/erp/imports/{importId}:execute for starting it, and POST /v2/erp/imports/{importId}:abort for stopping one that is still running

July 31, 2026

Entity API

New New optional variant_overridable field added to entity schema attributes — settable via POST/PUT /v1/entity/schemas/attributes/{composite_id}, PUT /v1/entity/schemas/{slug}, and the capability endpoints, and returned by the schema, capability, and blueprint read endpoints — marking whether an attribute may be overridden per entity variant

New New optional conditions field added to entity schemas, accepted on PUT /v1/entity/schemas/{slug} and returned by the schema read, list, versions, freeze, and unfreeze endpoints

Workflows Definition API

New 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

Workflows Execution API

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

July 30, 2026

Blueprint API

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

Journey Config API

Breaking 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

Changed 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

Pricing API

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

User API

New 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

July 29, 2026

Workflows Execution API

New 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

July 28, 2026

Entity API

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

July 27, 2026

App API

New 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

Blueprint API

New 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

Changed 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

Integration Toolkit API

Changed Passing group_id on events is now supported for parallelization within a batch of events in POST /v3/erp/updates/events

Changed 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

July 26, 2026

Blueprint API

New 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

Email Settings API

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

July 25, 2026

Integration Toolkit API

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

July 24, 2026

Integration Previous Provider API

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

July 22, 2026

Message API

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

Metering API

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

July 21, 2026

Notification API

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

July 16, 2026

Entity API

New 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

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

File API

New 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

July 15, 2026

Access Token API

New 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

Blueprint API

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