API Changelog
Breaking changes, new features, and significant updates to epilot APIs. Subscribe via RSS
November 2, 2026
Core Entities
Breaking Core entity schemas now reflect how epilot stores data โ Assignee fields, footnotes, product features and price tiers changed type in the schemas.
API details
- User assignment fields such as
assigned_toandassigneeare now arrays of user or user group references (withuser_id,group_id,org_id,email,display_name,phone, andimage_uri) instead of a single user object footnoteson coupons, prices, products, and taxes and the productfeaturefield changed from a string to an array of objects- Price
tierschanged from a single object to an array of tiers
Action needed Null and empty values โ Handle null attributes, empty relation arrays and relative link paths when reading entities.
API details
- Most entity attributes, enum values, and link
hrefvalues may now benull - Empty relations may be returned as empty arrays
- Link
hrefvalues may be paths within epilot 360 rather than absolute URLs
New Action needed Richer workflow summaries on entities โ Workflow summaries carry more detail about tasks, phases and closing reasons. Be prepared for the new task statuses and for previously required fields being absent.
API details
- New optional fields:
duedate,current_tasks,selected_closing_reasons,closing_reason_description,task_start_date, andphase_assignees - Previously required fields are now optional
- New task statuses:
SCHEDULED,PENDING,CONDITION_PENDING,WAITING_FOR_CONFIRMATION,WAITING_FOR_JOURNEY_SUBMISSION,ON_HOLD, andFAILED
November 1, 2026
Core Entities
New Action needed Rain water, EEG and warm water โ Contracts and meters can now be classified as rain water, renewable energy (EEG) or hot water. Be prepared for the new values.
API details
- Contract
branchand metersectoracceptrain_water,eeg, andwarm_water
October 30, 2026
Blueprint Manifest API
New Preview a deployment restore โ See what restoring a blueprint deployment would change before doing it.
API details
POST /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:restore-previewGET /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/restore-preview/{preview_id}
Entity Mapping API
Deprecated Mapping history โ GET /v1/mappings/history is deprecated.
SSO API
Deprecated OIDC client secret on identity providers โ oidc_config.client_secret is deprecated in requests to PUT /v1/sso/identity-providers/{slug} and wherever identity providers are read.
New SSO domains โ Register, verify and remove the domains used for single sign-on.
API details
GETandPOST /v1/sso/domainsDELETE /v1/sso/domains/{domain}POST /v1/sso/domains/{domain}/verify
October 29, 2026
Customer Portal API
Breaking Portal update endpoints removed โ PATCH /v2/portal/user was removed without deprecation, and the previously deprecated PATCH /v2/portal/opportunities/{id} and PATCH /v2/portal/order/{id} endpoints were removed.
Breaking SSO login error responses changed โ 400 responses from POST /v3/portal/public/sso/login no longer include message and instead return error, status, and an optional debug field.
New Debug mode for portal SSO โ Portal SSO identity providers can be put into debug mode through new optional debug_mode and debug_mode_until fields.
New Update contact fields directly โ PATCH /v2/portal/contact accepts contact fields directly.
API details
salutation,first_name,last_name,phone,mobile,street,street_number,postal_code,city,country,language, andcommunication_preferences
Minor PATCH /v2/portal/contract/{id} accepts new optional installment_amount and installment_amount_decimal fields
Email Settings API
New Action needed Link messages by identifier attributes โ A new AutoLinkIdentifierAttributesSetting setting type links messages automatically by identifier attributes. Be prepared for the new setting type.
API details
- Configured through new optional
schemasandexcluded_sendersfields - Accepted on
POST /v1/email-settingsandPOST /v1/email-settings/{id}and returned wherever settings are read
Integration Toolkit API
New Action needed File imports โ Run file imports through the API, with reusable import templates. Be prepared for the new file_import integration type.
API details
integration_typeaccepts the newfile_importvalue when creating or updating integrations and returns it wherever integrations are readGETandPOST /v2/imports,GETandDELETE /v2/imports/{importId},GET /v2/imports/{importId}/resultsPOST /v2/imports/{importId}:validate,:execute,:abort, and:suggest-templatesGETandPOST /v2/import-templatesandGET,PUT, andDELETE /v2/import-templates/{templateId}
Action needed New monitoring code โ Monitoring events, associated events, and trace spans can report SHARING_PARTNER_NOT_PROVISIONED.
Changed Dynamic partners in ERP entity sharing โ ERP use cases can resolve the partners to share with dynamically and restrict sharing. sharing.partners is no longer always present.
API details
- New optional
sharing.partner_lookupsfield for resolving partners dynamically - New optional
sharing.exclusivefield for restricting sharing sharing.partnersis no longer required in requests and may be missing in responses
Journey Config API
New Update a journey revision โ Journey revisions can be updated, and report when and by whom their metadata was last changed.
API details
PATCH /v1/journey/configuration/{id}/revisions/{revision_id}- New optional
metadata_updated_atandmetadata_updated_byfields on revisions
Message API
New Entity link suggestions โ Filter messages and threads by pending entity link suggestions, and restore dismissed suggestions.
API details
- New optional
view.has_link_suggestionfield onPOST /v1/message/messages:search,POST /v1/message/threads:searchIds, andPOST /v2/message/threads:search - New
POST /v1/message/threads/{id}/link-suggestions/restoreendpoint GET /v2/message/messages/{id}returns a new optionalauto_link_fieldsfield
October 28, 2026
Pricing API
New Organization conditional pricing settings โ GET /v1/conditional-pricing/organization returns the organization's conditional pricing settings.
Changed valid_from is a date โ valid_from on conditional pricing variants and variant versions is now a date (YYYY-MM-DD).
API details
- Applies to request bodies, the
{valid_from}path parameter, andvariants:batchUpsert/variants:batchDeleteitems - Applies wherever variants, versions, and resolved results are returned
Sharing API
Breaking Reduced shape for listed sharing configurations โ Items returned by GET /v1/sharing/configurations:list use a reduced partner sharing configuration shape.
API details
- No longer included: fields such as
partner_org_id,sharing_org_id,entities,offered_entities,users,user_limit,partner_status, and role details
Event: Meter Reading Added
New Meter reading photos โ Readings submitted with a photo now reference it, and committed-reading events carry the photos.
API details
- New optional
meter_readings[].file_idfield - New optional
event_attachmentsarray (with file ID, name, MIME type, size, and S3 reference) on committed-reading events; itsentity_idmatches the reading'sfile_id
October 27, 2026
AI Agents API
New Action needed Human approval for agent tool calls โ Agent tool calls can require human approval. Be prepared for the new approval_required event type in streams.
API details
POST /v1/chat,POST /v1/agents/{agent_id}/execute/stream, andGET /v1/executions/{execution_id}/streamcan emit the newapproval_requiredevent type with anapprovalpayloadPOST /v1/chataccepts a new optionaltool_approvalfield for answering an approval, withmessagenow optional- Pending actions carry a new optional
approval_note POST /v1/executions/{execution_id}/approveand/rejectcan respond with403and409
New Agent authentication settings โ Manage an agent's agent authentication settings through GET, PUT, and DELETE /v1/agents/{agent_id}/agent-auth.
Minor GET /v1/executions supports cursor-based pagination through a new optional cursor query parameter, and error responses across the API include an optional machine-readable code
Customer Portal API
Breaking Entity file deletion removed โ DELETE /v2/portal/entity/file was removed without deprecation.
October 23, 2026
Customer Portal API
New Passkeys for portal users โ Portal users can manage passkeys, and portals can enable passkey login.
API details
GETandPOST /v2/portal/user/passkeysandPATCHandDELETE /v2/portal/user/passkeys/{credential_id}; listed and created passkeys include a requiredis_usableflagPOST /v2/portal/user/passkeys/registration-optionsandPOST /v2/portal/user/passkeys/verification-code- New optional
auth_settings.passkeysfield for enabling passkey login, accepted when creating or updating portal configurations and returned wherever they are read - New optional
passkeyVerificationCodeemail template for customising the verification email
Workflows Definition API, Workflows Execution API
New Action needed Pass the workflow's main context to automations โ Tasks and triggers can define which context an automation receives, including the workflow's main context. Be prepared for the new main_context source value.
API details
- Flow template tasks accept a new optional
tasks[].input_contextfield onPOST /v2/flows/templatesandPUT /v2/flows/templates/{flowId}; it is returned wherever flow templates are read - Automation input contexts accept the new
main_contextvalue forsource, together with new optionalalso_passandwith_relationsfields, and a new optionaloutput_context.attach_to_contextsfield - On executions these are accepted on
POST /v2/flows/executions,POST /v2/flows/executions/{execution_id}/tasks, andPATCH /v2/flows/executions/{execution_id}/tasks/{task_id}and returned wherever flow executions and tasks are read - Tasks return their input context through a new optional
input_contextfield wherever flow executions and tasks are read
New Run automations on behalf of a user โ Automations on triggers and tasks can run as a specific user.
API details
- New optional
automation_config.run_for_user_idfield, accepted onPOST /v2/flows/executions,POST /v2/flows/executions/{execution_id}/tasks, andPATCH /v2/flows/executions/{execution_id}/tasks/{task_id}and returned wherever flow executions and tasks are read
Lead Entity
New Lead entity โ A new lead core entity captures and qualifies sales leads.
API details
- Fields for status, lead type, channel, qualification stage, lead scoring, follow-up, disqualification, conversion, offer status, and UTM campaign tracking
- Relations to the customer contact, delivery and billing addresses, products, campaign, reporting partner, partner contact, the created opportunity, and duplicate leads
October 22, 2026
Configuration Hub API
Minor POST /v1/configs/sync-jobs accepts a new optional sync_portal_widgets field to include portal widgets in a configuration sync job
Entity API
New Action needed Portal role attributes โ Entity schemas can define portal role attributes. Be prepared for the new PortalRoleAttribute attribute type.
API details
- Accepted when creating or updating schema attributes, capabilities, and schemas
- Returned wherever entity schemas are read
October 21, 2026
AI Agents API
New Customer chat conversations โ List and read the conversations of a customer chat agent.
API details
GET /v1/customer-chat/{agent_id}/conversationsGET /v1/customer-chat/{agent_id}/conversations/{conversation_id}
Automation API
New Control partner sharing from automation actions โ Automation actions can choose the sharing operation and unshare from all partners.
API details
- New optional
actions[].config.operationandactions[].config.unshare_all_partnersfields - Accepted on
POST /v1/automation/flowsandPUT /v1/automation/flows/{flow_id}and returned wherever flows and executions are read
File API
New Attribute suggestions for files โ Create and track jobs that suggest attributes for a file.
API details
POST /v1/files/{id}/attribute-suggestion-jobsGET /v1/files/{id}/attribute-suggestion-jobs/latestGETandPATCH /v1/files/{id}/attribute-suggestion-jobs/{job_id}
GenAI API
Breaking Table filter endpoint removed โ POST /v1/genai/entity/getTableFiltersV2 was removed without deprecation.
Integration Toolkit API
Action needed New monitoring codes โ Monitoring events, associated events, and trace spans can report new codes for sharing, reference resolution, unique identifiers and webhook delivery.
API details
- Sharing:
SHARING_FAILED,SHARING_PARTNER_NOT_CONNECTED, andSHARING_REJECTED - Environment variable and portal reference resolution:
ENV_VAR_REF_*,PORTAL_REF_* - Missing unique identifiers:
MISSING_METER_UNIQUE_IDS,MISSING_METER_COUNTER_UNIQUE_IDS,RELATION_MISSING_UNIQUE_IDS,UNIQUE_ID_TYPE_DERIVATION_FAILED - Webhook delivery:
WEBHOOK_DELIVERY_FAILED,WEBHOOK_SKIPPED ORG_DROPPEDandSECURE_PROXY_OK
New Share synced entities with partners โ ERP use cases can share the entities they sync with partners.
API details
- New optional
configuration.entities[].sharingfield, accepted when creating or updating use cases and integrations and in the mapping and direct simulation endpoints - The simulation endpoints return the resulting
entity_updates[].sharing