Skip to main content

API Changelog

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

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