Breaking (!) API changes for v2 API, November 13 to November 20
In the week of 11/13/2026 to 11/20/2026, the mittwald API underwent significant changes, including the removal of multiple API paths and schemas without deprecation, the addition of new endpoints, and updates to response properties, enhancing the overall functionality and structure of the API.
Summary
-
The following API paths have been removed without deprecation, resulting in breaking changes:
GET /v2/cities(Operation ID:leadfyndr-get-cities)GET /v2/customers/{customerId}/lead-fyndr-profile(Operation ID:leadfyndr-get-lead-fyndr-profile)GET /v2/customers/{customerId}/lead-fyndr-profile-request(Operation ID:leadfyndr-get-lead-fyndr-profile-request)POST /v2/customers/{customerId}/lead-fyndr-profile-request(Operation ID:leadfyndr-create-lead-fyndr-access-request)GET /v2/customers/{customerId}/lead-fyndr-profile/tariff(Operation ID:leadfyndr-get-lead-fyndr-profile-tariff-options)GET /v2/customers/{customerId}/leads(Operation ID:leadfyndr-list-leads)GET /v2/customers/{customerId}/leads/{leadId}(Operation ID:leadfyndr-get-lead)GET /v2/customers/{customerId}/unlocked-leads(Operation ID:leadfyndr-list-unlocked-leads)POST /v2/customers/{customerId}/unlocked-leads-export(Operation ID:leadfyndr-create-leads-export)GET /v2/customers/{customerId}/unlocked-leads-exports(Operation ID:leadfyndr-get-leads-export-history)GET /v2/customers/{customerId}/unlocked-leads/{leadId}(Operation ID:leadfyndr-get-unlocked-lead)POST /v2/customers/{customerId}/unlocked-leads/{leadId}(Operation ID:leadfyndr-unlock-lead)DELETE /v2/customers/{customerId}/unlocked-leads/{leadId}/reservation(Operation ID:leadfyndr-remove-unlocked-lead-reservation)POST /v2/customers/{customerId}/unlocked-leads/{leadId}/reservation(Operation ID:leadfyndr-reserve-unlocked-lead)
-
The following schemas have been removed:
de.mittwald.v1.leadfyndr.BasicCompanyde.mittwald.v1.leadfyndr.BasicMetricsde.mittwald.v1.leadfyndr.Cityde.mittwald.v1.leadfyndr.Contactde.mittwald.v1.leadfyndr.DetailCompanyde.mittwald.v1.leadfyndr.DetailMetricsde.mittwald.v1.leadfyndr.Hosterde.mittwald.v1.leadfyndr.Leadde.mittwald.v1.leadfyndr.LeadsExportde.mittwald.v1.leadfyndr.LeadsExportExporterde.mittwald.v1.leadfyndr.Lighthousede.mittwald.v1.leadfyndr.Metricde.mittwald.v1.leadfyndr.Profilede.mittwald.v1.leadfyndr.ProfileRequestde.mittwald.v1.leadfyndr.SocialMediade.mittwald.v1.leadfyndr.TariffOptionsde.mittwald.v1.leadfyndr.Technologyde.mittwald.v1.leadfyndr.UnlockedLeadde.mittwald.v1.leadfyndr.User
-
The following optional properties have been added to the response with a
200status for the operationGET /v2/ai-hosting-keys(Operation ID:ai-hosting-user-get-keys):/items/tokenUsage/keyAvailable/items/tokenUsage/keyLimit
-
New endpoints have been added:
GET /v2/aissistant-chats(Operation ID:aissistant-list-chats) to list the chats of the authenticated user.DELETE /v2/aissistant-chats/{chatId}(Operation ID:aissistant-delete-chat) to delete a chat of the authenticated user.GET /v2/aissistant-chats/{chatId}(Operation ID:aissistant-get-chat) to get one chat of the authenticated user.PUT /v2/aissistant-chats/{chatId}(Operation ID:aissistant-save-chat) to save the whole chat after a finished answer.POST /v2/aissistant-chats/{chatId}/actions/run(Operation ID:aissistant-run-chat) to run the AIssistant on a chat and stream its answer.POST /v2/authinfo2/check-domain(Operation ID:domain-check-authinfo2) to check if a domain is eligible for AuthInfo2.GET /v2/compromised-password-hashes/ranges/{hashPrefix}(Operation ID:hibp-get-compromised-password-hash-range) to get the leaked-password suffixes of a SHA-1 prefix.
-
The response property 'message' has become required for the status '429' for the following operations:
POST /v2/authenticate(Operation ID:user-authenticate)POST /v2/authenticate-mfa(Operation ID:user-authenticate-mfa)POST /v2/register(Operation ID:user-register)
-
The response property 'type' has become required for the status '429' for the following operations:
POST /v2/authenticate(Operation ID:user-authenticate)POST /v2/authenticate-mfa(Operation ID:user-authenticate-mfa)POST /v2/register(Operation ID:user-register)
-
The following non-success responses have been added:
- Status '400' for
PUT /v2/deliveryboxes/{id}/password(Operation ID:deprecated-mail-deliverybox-update-password). - Status '412' for:
POST /v2/extension-instances/{extensionInstanceId}/sessions/{sessionId}(Operation ID:extension-generate-session-token).POST /v2/order-previews(Operation ID:order-preview-order).POST /v2/orders(Operation ID:order-create-order).GET /v2/projects/{projectId}/usage-metrics(Operation ID:project-get-usage-metrics).GET /v2/projects/{projectId}/usage-metrics/breakdown(Operation ID:project-get-usage-metrics-breakdown).GET /v2/servers/{serverId}/usage-metrics(Operation ID:project-get-server-usage-metrics).GET /v2/servers/{serverId}/usage-metrics/breakdown(Operation ID:project-get-server-usage-metrics-breakdown).POST /v2/tariff-change-previews(Operation ID:order-preview-tariff-change).POST /v2/tariff-changes(Operation ID:order-create-tariff-change).
- Status '400' for
-
The following required properties have been added to the response with a
200status:/items/mailbox/authenticationDisabledforGET /v2/mail-addresses/(Operation ID:mail-list-mail-addresses-for-user).mailbox/authenticationDisabledforGET /v2/mail-addresses/{mailAddressId}(Operation ID:mail-get-mail-address)./items/mailbox/authenticationDisabledforGET /v2/projects/{projectId}/mail-addresses(Operation ID:mail-list-mail-addresses).
Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below.
Detailed changes
Changes in "leadfyndr-get-cities"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-get-cities endpoint.
Changes in "leadfyndr-get-lead-fyndr-profile"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-get-lead-fyndr-profile endpoint.
Changes in "leadfyndr-get-lead-fyndr-profile-request"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-get-lead-fyndr-profile-request endpoint.
Changes in "leadfyndr-create-lead-fyndr-access-request"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-create-lead-fyndr-access-request endpoint.
Changes in "leadfyndr-get-lead-fyndr-profile-tariff-options"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-get-lead-fyndr-profile-tariff-options endpoint.
Changes in "leadfyndr-list-leads"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-list-leads endpoint.
Changes in "leadfyndr-get-lead"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-get-lead endpoint.
Changes in "leadfyndr-list-unlocked-leads"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-list-unlocked-leads endpoint.
Changes in "leadfyndr-create-leads-export"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-create-leads-export endpoint.
Changes in "leadfyndr-get-leads-export-history"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-get-leads-export-history endpoint.
Changes in "leadfyndr-get-unlocked-lead"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-get-unlocked-lead endpoint.
Changes in "leadfyndr-unlock-lead"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-unlock-lead endpoint.
Changes in "leadfyndr-remove-unlocked-lead-reservation"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-remove-unlocked-lead-reservation endpoint.
Changes in "leadfyndr-reserve-unlocked-lead"
- Breaking api path removed without deprecation
For details, refer to the unknown operation leadfyndr-reserve-unlocked-lead endpoint.
Changes in ""
-
removed the schema 'de.mittwald.v1.leadfyndr.BasicCompany'
-
removed the schema 'de.mittwald.v1.leadfyndr.BasicMetrics'
-
removed the schema 'de.mittwald.v1.leadfyndr.City'
-
removed the schema 'de.mittwald.v1.leadfyndr.Contact'
-
removed the schema 'de.mittwald.v1.leadfyndr.DetailCompany'
-
removed the schema 'de.mittwald.v1.leadfyndr.DetailMetrics'
-
removed the schema 'de.mittwald.v1.leadfyndr.Hoster'
-
removed the schema 'de.mittwald.v1.leadfyndr.Lead'
-
removed the schema 'de.mittwald.v1.leadfyndr.LeadsExport'
-
removed the schema 'de.mittwald.v1.leadfyndr.LeadsExportExporter'
-
removed the schema 'de.mittwald.v1.leadfyndr.Lighthouse'
-
removed the schema 'de.mittwald.v1.leadfyndr.Metric'
-
removed the schema 'de.mittwald.v1.leadfyndr.Profile'
-
removed the schema 'de.mittwald.v1.leadfyndr.ProfileRequest'
-
removed the schema 'de.mittwald.v1.leadfyndr.SocialMedia'
-
removed the schema 'de.mittwald.v1.leadfyndr.TariffOptions'
-
removed the schema 'de.mittwald.v1.leadfyndr.Technology'
-
removed the schema 'de.mittwald.v1.leadfyndr.UnlockedLead'
-
removed the schema 'de.mittwald.v1.leadfyndr.User'
For details, refer to the unknown operation endpoint.
Changes in "Get all ai hosting keys the authenticated user can access"
-
added the optional property '/items/tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property '/items/tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "List the chats of the authenticated user"
- endpoint added
For details, refer to the GET/v2/
Changes in "Delete a chat of the authenticated user"
- endpoint added
For details, refer to the DELETE/v2/
Changes in "Get one chat of the authenticated user"
- endpoint added
For details, refer to the GET/v2/
Changes in "Save the whole chat after a finished answer"
- endpoint added
For details, refer to the PUT/v2/
Changes in "Run the AIssistant on a chat and stream its answer"
- endpoint added
For details, refer to the POST/v2/
Changes in "Authenticate yourself to get an access token"
-
the response property 'message' became required for the status '429'
-
the response property 'type' became required for the status '429'
For details, refer to the POST/v2/
Changes in "Validate your second factor"
-
the response property 'message' became required for the status '429'
-
the response property 'type' became required for the status '429'
For details, refer to the POST/v2/
Changes in "Check if a Domain is eligible for AuthInfo2"
- endpoint added
For details, refer to the POST/v2/
Changes in "Get the leaked-password suffixes of a SHA-1 prefix"
- endpoint added
For details, refer to the GET/v2/
Changes in "Get a list of already created keys"
-
added the optional property '/items/tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property '/items/tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Creates a new key"
-
added the new optional request property 'tokenLimit'
-
added the optional property 'tokenUsage/keyAvailable' to the response with the '201' status
-
added the optional property 'tokenUsage/keyLimit' to the response with the '201' status
For details, refer to the POST/v2/
Changes in "Get a key of a customer"
-
added the optional property 'tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property 'tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Update a key for a customer"
-
added the new optional request property 'tokenLimit'
-
added the optional property 'tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property 'tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the PUT/v2/
Changes in "Rotates a customer's key"
-
added the optional property 'tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property 'tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the POST/v2/
Changes in "Update the password for a specific deliverybox"
- added the non-success response with the status '400'
For details, refer to the PUT/v2/
Changes in "Generate a session token to transmit it to the extensions frontend fragment"
- added the non-success response with the status '412'
For details, refer to the POST/v2/
Changes in "List mail addresses"
- added the required property '/items/mailbox/authenticationDisabled' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Get a mail address"
- added the required property 'mailbox/authenticationDisabled' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Preview Order"
- added the non-success response with the status '412'
For details, refer to the POST/v2/
Changes in "Create an Order"
- added the non-success response with the status '412'
For details, refer to the POST/v2/
Changes in "Get a list of keys of a project"
-
added the optional property '/items/tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property '/items/tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Creates a new key for a project"
-
added the optional property 'tokenUsage/keyAvailable' to the response with the '201' status
-
added the optional property 'tokenUsage/keyLimit' to the response with the '201' status
For details, refer to the POST/v2/
Changes in "Get a key of a project"
-
added the optional property 'tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property 'tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Update a key for a project"
-
added the optional property 'tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property 'tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the PUT/v2/
Changes in "Rotates a project's key"
-
added the optional property 'tokenUsage/keyAvailable' to the response with the '200' status
-
added the optional property 'tokenUsage/keyLimit' to the response with the '200' status
For details, refer to the POST/v2/
Changes in "List mail addresses belonging to a Project"
- added the required property '/items/mailbox/authenticationDisabled' to the response with the '200' status
For details, refer to the GET/v2/
Changes in "Get usage metrics for a project"
- added the non-success response with the status '412'
For details, refer to the GET/v2/
Changes in "Get a usage-metrics breakdown for a project"
- added the non-success response with the status '412'
For details, refer to the GET/v2/
Changes in "Register with email and password"
-
the response property 'message' became required for the status '429'
-
the response property 'type' became required for the status '429'
For details, refer to the POST/v2/
Changes in "Get usage metrics for a server"
- added the non-success response with the status '412'
For details, refer to the GET/v2/
Changes in "Get a usage-metrics breakdown for a server"
- added the non-success response with the status '412'
For details, refer to the GET/v2/
Changes in "Preview TariffChange"
- added the non-success response with the status '412'
For details, refer to the POST/v2/
Changes in "Create TariffChange Order"
- added the non-success response with the status '412'
For details, refer to the POST/v2/
Client package releases
Release v2.2.30 of mittwald PHP SDK
The mittwald PHP SDK has released version v2.2.30, which focuses on improving error handling for the ExtensionGenerateSessionToken endpoint. This update introduces dedicated support for HTTP 412 (Precondition Failed) responses. The marketplace client now effectively parses, validates, and structures error payloads when precondition checks fail, replacing generic fallback handlers with specific response objects.
New Features
- HTTP 412 Precondition Failed Handling: A new
ExtensionGenerateSessionTokenPreconditionFailedResponsehas been added to handle412status codes during session token generation. TheMarketplaceClientImplhas been updated to direct these responses to the new handler, ensuring consistent error reporting and structuredErrorbody parsing for precondition failures.
For more details, visit the release page.
mittwald PHP SDK v2.2.29 Release Summary
The mittwald PHP SDK has been updated to version 2.2.29. This release introduces several new features, improvements, and deprecations.
Features
- Added explicit support for handling HTTP 412 Precondition Failed errors in contract ordering and tariff preview workflows. This includes new structured response classes and client-side type mapping to help developers manage precondition violations effectively:
OrderCreateOrderPreconditionFailedResponseOrderCreateTariffChangePreconditionFailedResponseOrderPreviewOrderPreconditionFailedResponseOrderPreviewTariffChangePreconditionFailedResponse
- Updated
ContractClientImplto handle HTTP 412 status codes with the appropriate typed error responses.
Improvements
- Unified error schema for rate limit responses by refactoring
TooManyRequestsresponse handling for user authentication and registration endpoints. This change replaces redundant local response body classes with a sharedde.mittwald.v1.commons.Errorschema, ensuring consistency in error payload structures.
Deprecations
- Deprecated the following Order schemas due to the discontinuation of the LeadFyndr product:
Requests targeting these schemas will now result in a
LeadFyndrOrderLeadFyndrOrderPreviewLeadFyndrOrderPreviewResponseLeadFyndrTariffChange
LeadFyndrDiscontinuederror.
For more details, visit the release page.
mittwald PHP SDK v2.2.28 Release Summary
The mittwald PHP SDK has been updated to version v2.2.28. This release includes significant changes and new features:
-
Breaking Changes: The
LeadFyndrclient and all related components have been removed. This includes the deletion of files undersrc/Generated/V2/Clients/LeadFyndr/andsrc/Generated/V2/Schemas/Leadfyndr/. TheClientandClientImplno longer support theleadFyndr()method. -
New Features: A new method
checkAuthinfo2(CheckAuthinfo2Request $request): CheckAuthinfo2OKResponsehas been added to theDomainClientinterface andDomainClientImpl. This introduces a newCheckAuthinfo2namespace, enabling a streamlined process for checking domain eligibility for AuthInfo2 transfers. The API now sends aPOSTrequest to/v2/authinfo2/check-domainto verify domain eligibility, providing detailed diagnostic reasons if a domain is ineligible. -
Internal Refactoring: Several classes from the deprecated LeadFyndr module have been repurposed to support the new
CheckAuthinfo2functionality. Updates have been made to request/response validation schemas, HTTP method mappings, and URL builders to align with the revised API specification.
For more details, visit the release page.
mittwald JavaScript SDK Release 4.530.0
The mittwald JavaScript SDK has been updated to version 4.530.0. This release includes an update to the generated client, enhancing the functionality and performance of the SDK. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.530.0.
mittwald JavaScript SDK Release 4.529.0
The mittwald JavaScript SDK has been updated to version 4.529.0. This release includes an update to the generated client, enhancing its functionality. For more details, you can view the release on GitHub.
mittwald JavaScript SDK Release 4.528.0
The mittwald JavaScript SDK has been updated to version 4.528.0. This release includes an update to the generated client, enhancing its functionality. For more details, you can view the release on GitHub here.
mittwald JavaScript SDK Release 4.527.0
The mittwald JavaScript SDK has been updated to version 4.527.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.
mittwald JavaScript SDK Release 4.526.0
The mittwald JavaScript SDK has been updated to version 4.526.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub here.
mittwald JavaScript SDK Release 4.525.0
The mittwald JavaScript SDK has been updated to version 4.525.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.525.0.