uninstall_connector

Uninstall a connector from a project — grants revoked, resources detached, the row kept — with two opt-ins for the plans it empties. Destructive.

Purpose

Distinct from disconnecting and never a deletion. Every live grant on the connector's resources is revoked (members are put outside; member.resource_removed per grant), its resources are deactivated as detached with their external ids kept, the installation row stays with uninstalled_at, identities are never removed, and no money moves by itself. Two opt-ins, both on by default, act on the plans left with nothing to grant: unpublish_emptied_plans takes them off sale; cancel_recurring_subscriptions cancels their live recurring subscriptions at the end of the paid period and emails each member. One-time and lifetime purchases are never cancelled. Always read get_connector_uninstall_preview and confirm with the creator first. The REST twin is DELETE /v1/projects/{project}/connectors/{key}.

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."
    },
    "unpublish_emptied_plans": {
      "type": "boolean",
      "description": "Take the plans left with nothing to grant off sale. Default true."
    },
    "cancel_recurring_subscriptions": {
      "type": "boolean",
      "description": "Cancel the live recurring subscriptions on those plans at the end of their paid period and email each member. Default true."
    }
  }
}

Output shape

{
  "data": {
    "installation": { "id": "3b8f0c6e-2d41-4a97-9e5f-1c7d6b2a8e40", "connector": "discord", "state": "disconnected", "operational": false, "uninstalled_at": "2026-09-12T11:30:00+00:00" },
    "connector": "discord",
    "grants_revoked": 41,
    "resources_detached": 2,
    "plans_unpublished": 1,
    "subscriptions_cancelled": 17,
    "members_notified": 17
  },
  "meta": {}
}

Events emitted

Example prompts

"Remove Discord from Research Premium, take the Lounge plan off sale and let its subscribers run out at period end."

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