Deprecate an operation in a custom connector

When you need to retire an operation in your custom connector, mark it as deprecated. This approach lets existing users keep using the operation while stopping new users from adopting it. If you're deprecating an operation of a certified connector, follow the standards of deprecation by giving users notice at least 30 days before the deprecation date. Contact the Microsoft connector support team through Partner Center to ensure you take the necessary steps.

Note

Stop Sell doesn't work in Partner Center for connectors. To stop new users from using an operation, mark it as deprecated in the apiDefinition.swagger.json file.

How to mark an operation as deprecated

Deprecate any action or trigger in a custom connector by making the following changes to the apiDefinition.swagger.json file:

  1. Set the deprecated attribute for the operation to true.

  2. Append (deprecated) to the summary and description attributes.

{
  "/{list}/items": {
    "get": {
      "summary": "Get rows (deprecated)",
      "description": "This operation gets a list of items (deprecated).",
      "operationId": "GetItems",
      "deprecated": true
    }
  }
}

If you're introducing a new version of the operation to replace the deprecated one (for example, in version 2), use x-ms-api-annotation.family and x-ms-api-annotation.revision, as shown in the following example:

{
  "/{list}/items": {
    "get": {
      "summary": "Get rows (deprecated)",
      "description": "This operation gets a list of items (deprecated).",
      "operationId": "GetItems",
      "deprecated": true,
      "x-ms-api-annotation": {
        "family": "GetItems",
        "revision": 1
      }
    }
  },
  "/v2/{list}/items": {
    "get": {
      "summary": "Get rows",
      "description": "This operation gets a list of items.",
      "operationId": "GetItems_V2",
      "deprecated": false,
      "x-ms-api-annotation": {
        "family": "GetItems",
        "revision": 2
      }
    }
  }
}

Note

Note how both operations belong to the same family, and the revision number is increased.

Deprecated operation behavior

After an operation is deprecated, expect the following Microsoft Copilot Studio and Power Platform behavior:

  • Flows and apps that already use this operation continue to work as before. They don't stop working.
  • The designer hides deprecated operations, so new flows can't use them.

Provide feedback

We greatly appreciate feedback on issues with our connector platform, or new feature ideas. To provide feedback, go to Submit issues or get help with connectors and select your feedback type.

  • Last updated on