Skip to main content

API Changelog

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

2026-10-20 External Values API

  • Hooks returned by GET /v1/external-values can now include the new value context requirement type in hooks[].contexts, so consumers must be prepared for this additional type

2026-10-20 Identity API

  • New GET /v1/identity/sector-identifier/{client_id} endpoint was added for reading the sector identifier of a client

2026-10-20 Integration Toolkit API

  • The v1 monitoring endpoints POST /v1/integrations/{integrationId}/monitoring/inbound-events, outbound-events, stats, and timeseries are now deprecated in favour of their /v2 counterparts

2026-10-20 Journey Config API

  • New GET /v1/journey/template-variables endpoint was added for listing the template variables available to journeys, and v1 journey configurations now carry their templating context wherever they are read
  • blueprint_customization was removed from journey configurations: it is no longer accepted when creating or updating a journey configuration or revision in v1 and v2, and no longer returned wherever journey configurations are read (breaking)

2026-10-20 Phone Integration API

  • New GET and POST /v1/manager/agents and DELETE /v1/manager/agents/{user_id} endpoints were added for managing phone agents, together with a new GET /v1/manager/status endpoint for reading the phone integration status
  • New GET /v1/manager/live, GET /v1/manager/agents/live, GET /v1/manager/queues, GET /v1/manager/queues/{queue_id}, and GET /v1/manager/reporting/calls endpoints were added for monitoring live agent and queue activity and reporting on calls, together with new PUT /v1/manager/agents/{provider_agent_id}/routing and POST /v1/manager/agents/{provider_agent_id}/routing:preview endpoints for configuring and previewing an agent's call routing
  • New PUT /v1/manager/agents/{provider_agent_id}/presence and GET /v1/manager/presences endpoints were added for setting an agent's presence and listing agent presences

2026-10-20 Sharing API

  • New GET /v1/sharing/configurations:list endpoint was added for listing sharing configurations

2026-10-20 Snapshot API

  • Scheduled org snapshots can now be skipped: last_status on GET and PUT /v1/org-snapshot-schedule can return the new skipped value together with a new optional last_status_reason field, so consumers must be prepared for this additional status
  • DELETE /v1/snapshots/{id} can now respond with 409 when a conflicting operation is in progress

2026-10-19 Pricing API

  • fields is no longer accepted on POST /v1/public/catalog (breaking)
  • The required warnings field was removed from the POST /v2/public/catalog response (breaking)

2026-10-19 Notification Template Entity

  • Notification templates can now have a separate title and message for the end-customer portal through new portal_title and portal_message fields, which fall back to the regular title and message when empty

2026-10-16 Automation API

  • Assignment actions can now require skills from their assignees through new optional actions[].config.required_skills and actions[].config.required_skills_match_mode fields — accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows and executions are read

2026-10-16 Design Builder API

  • New POST /v1/designs/generate endpoint was added for generating a design

2026-10-16 Integration Toolkit API

  • Import validation can now report the new issue codes UNIQUE_ID_NOT_IN_SCHEMA and VALID_FROM_NOT_MAPPED, and issue attributes carry a new optional entity detail — returned by all /v2/erp/imports endpoints, so consumers must be prepared for these additional issue codes

2026-10-16 Workflows Definition API

  • Task conditions in flow templates can now reference flow runtime and flow trait values through the new flow_runtime value for source.origin and flow_trait value for source.origin_type, so consumers reading flow templates must be prepared for these additional values

2026-10-15 Entity API

  • New GET /v1/entity:importHistory endpoint was added for listing past entity imports, and imports now report their progress through new optional phase, started_at, heartbeat_at, finished_at, and issues fields
  • failure_code on POST /v1/entity:import and GET /v1/entity:import:latest can now return new values such as dry_run_required, dry_run_expired, dry_run_mismatch, import_too_large, and token_expired, so consumers must be prepared for these additional failure codes
  • New GET /v1/entity/{slug}/{id}/summary endpoint was added for reading a summary of an entity
  • Entity schemas can now require a comment on changes through a new optional require_change_comment field — accepted on PUT /v1/entity/schemas/{slug} and returned wherever entity schemas are read

2026-10-15 GenAI API

  • GET /v1/genai/thread/{threadId}/info, GET and POST /v1/genai/entity/{slug}/{entity_id}/summary, and POST /v1/genai/portal/getDesign endpoints were removed without deprecation (breaking)

2026-10-15 Message API

  • New GET /v1/message/threads/{id}/summary endpoint was added for reading a summary of a message thread

2026-10-15 Pricing API

  • Variant conditions on POST /v1/conditional-pricing/{slug}/entities/{entity_id}/variants:list and POST /v1/conditional-pricing/{slug}/entities/{entity_id}/variants:tree now use the new ContextConditionValue and PostalCodeFilter shapes; the previous PostalCodeCity and ConditionPredicate shapes are no longer accepted in conditions (breaking)

2026-10-15 Core Entities

  • Coupon, Price, Product, and Tax entities can now carry footnotes through a new footnotes field

2026-10-14 Entity API

  • New GET /v1/entity:wipeJobs endpoint was added for listing entity wipe jobs
  • POST /v1/entity:wipeAllEntities now accepts at most 90 schemas per request (breaking) and can respond with 409 when a wipe is already in progress

2026-10-14 Integration Toolkit API

  • New GET /v3/erp/updates/events, GET /v3/erp/updates/events/{event_id}, and GET /v3/erp/updates/correlations endpoints were added for tracking submitted ERP update events and their correlations, including whether a correlation is complete and its errors_total
  • ERP updates can now be processed interactively: POST /v3/erp/updates/events accepts new optional interactive, events[].interactive, and correlation_complete fields, use cases accept a new optional configuration.interactive field, and the /v1, /v2, and /v3 erp/updates/events endpoints now return a correlation_id together with each result's interactive flag and lane
  • New POST /v2/integrations/{integrationId}/monitoring/runs/completion endpoint was added for reporting the completion of a monitoring run
  • group_id and events[].group_id on POST /v3/erp/updates/events must now be non-empty and contain only printable characters without spaces
  • code on monitoring events, associated events, and trace spans is no longer always a string, so consumers must handle other value types
  • ERP update submissions on the /v1, /v2, and /v3 erp/updates/events endpoints now return a new optional correlation_close field, v3 events and correlations report omitted entities through a new optional entities_omitted field, and monitoring events, associated events, and trace spans can now report the new PROCESSING_STATE_LIMIT code, so consumers must be prepared for this additional value

2026-10-13 Automation API

  • actions[].config.candidate_group on automation flows is now deprecated in favour of the new optional actions[].config.candidate_pool field — accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows and executions are read
  • Automation bulk jobs can now be restarted: PATCH /v1/automation/executions/bulk-jobs/{job_id} accepts the new RESTART value for action and no longer requires task_token, and bulk jobs report their restarts through new optional restart_count, restarted_at, and last_error fields
  • Bulk jobs now report execution statistics through new optional execution_stats and execution_summary_truncated fields, and GET /v1/automation/executions/bulk-jobs/{job_id} accepts a new optional include_execution_summary query parameter

2026-10-13 Email Settings API

  • New POST /v2/outlook/mailbox/{email}/sync/cancel endpoint was added for cancelling a running mailbox sync
  • Outlook mailboxes can now be synced for the last 3 months, 6 months, or year: mailboxSyncTimeframe on POST /v2/outlook/mailbox/connect and timeframe on POST /v2/outlook/mailbox/{email}/sync accept the new 3m, 6m, and 1y values, which are also returned by the sync and GET /v2/outlook/mailbox/{email}/sync/status endpoints, so consumers must be prepared for these additional timeframes

2026-10-13 Message API

  • Messages can now come with suggested entity links: GET /v2/message/messages/{id} returns a new optional link_suggestions field, and new POST /v1/message/threads/{id}/link-suggestions/dismiss endpoint was added for dismissing suggestions
  • GET /v1/message/threads/{id}/timeline can now return the new MessageEntityLinkSuggestedEvent and MessageEntityLinkSuggestionDismissedEvent event types, so consumers must be prepared for these additional events

2026-10-13 Workflows Definition API

  • Flow template tasks can now have a start date through new optional tasks[].start_date and tasks[].start_date_config fields, and due dates can now be set relative to it: due_date_config.type accepts the new START_DATE value on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId} and returns it wherever flow templates are read, so consumers must be prepared for this additional due date type

2026-10-13 Workflows Execution API

  • Tasks can now have a start date through new optional start_date and start_date_config fields, returned wherever flow executions and tasks are read, and due dates can now be set relative to it: due_date_config.type accepts the new START_DATE value on the execution, phase, and task create/update endpoints and returns it wherever flow executions, phases, and tasks are read, so consumers must be prepared for this additional due date type