disconnect_connector

Disconnect a project's installation of one connector — the connector withdraws it, the credentials are wiped, the row stays. Destructive.

Purpose

Detaches a project's live installation of one connector. The connector withdraws the installation on its platform, the credentials are wiped and the installation turns disconnected. Members keep the access they hold; grants, resources, plans and identities are untouched; the creator can connect it again from the dashboard. An installation already disconnected is left alone. The REST twin is DELETE /v1/projects/{project}/connectors/{key}/installation.

Required ability

project-connector:delete

Input schema

{
  "type": "object",
  "required": ["project_id", "connector"],
  "properties": {
    "project_id": {
      "type": "string",
      "description": "UUID of the project."
    },
    "connector": {
      "type": "string",
      "description": "The connector key, as list_connectors returns it."
    }
  }
}

Output shape

{
  "data": {
    "installation_id": "3b8f0c6e-2d41-4a97-9e5f-1c7d6b2a8e40",
    "connector": "telegram",
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "disconnected": true
  },
  "meta": {}
}

Events emitted

Example prompts

"Disconnect the Telegram bot from Research Premium; I'll connect a new one tomorrow."

Failure modes

  • AUTHENTICATION_REQUIRED — no authenticated user on the request.
  • TOKEN_MISSING_ABILITY — token lacks project-connector:delete.
  • RESOURCE_NOT_FOUND — the project is not visible to this token, or context.reason is unknown_connector.
  • CONNECTOR_NOT_INSTALLED — the project has no installation of the connector.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request