---
title: "Uninstall a connector"
method: DELETE
path: "/v1/projects/{project}/connectors/{key}"
tags: ["Connectors"]
---

# Uninstall a connector

`DELETE /v1/projects/{project}/connectors/{key}`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/connectors/{key}`
- Auth: HTTP bearer

```bash
curl -X DELETE https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/connectors/example \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"unpublish_emptied_plans": true, "cancel_recurring_subscriptions": false}'
```

In order: the connector puts every member outside while its credentials still work, the rows are retired in one transaction (grants revoked, resources detached, the installation kept with `uninstalled_at`), the connector withdraws the installation, and the two opt-ins run. `unpublish_emptied_plans` (default `true`) takes the emptied plans off sale, firing `plan.deactivated` per plan; `cancel_recurring_subscriptions` (default `true`) cancels their live recurring subscriptions at the end of the paid period, firing `subscription.cancelled` per subscription and emailing each member that their subscription will not renew. One-time and lifetime purchases are never cancelled; a refund stays the creator's call. Identities are never removed. `connector.uninstalled` fires with the counts. Installing the connector again brings the same installation back as pending with its settings kept.

The two opt-ins travel in the JSON body or as query parameters; on by default, they only need sending to switch one off.

## Path parameters

- `project` string, uuid, required
- `key` string, required

## Query parameters

- `unpublish_emptied_plans` boolean
- `cancel_recurring_subscriptions` boolean

## Headers

- `Idempotency-Key` string, uuid, required

## Response `200`

200 with the report.

- object
  - `data` UninstallReportResource, required: What an uninstall did: the same numbers the `connector.uninstalled` event carries, beside the installation as it stands afterwards.
    - `installation` unknown[], required: The installation as it stands afterwards, `disconnected` with `uninstalled_at` set, in the installation object's shape.
      - unknown
    - `connector` string, required: The connector's key.
    - `grants_revoked` integer, required: How many grants were revoked.
    - `resources_detached` integer, required: How many places were detached.
    - `plans_unpublished` integer, required: How many emptied plans were taken off sale by the opt-in.
    - `subscriptions_cancelled` integer, required: How many recurring subscriptions were cancelled at the end of their paid period by the opt-in.
    - `members_notified` integer, required: How many members were emailed that their subscription will not renew.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred. On this endpoint: `RESOURCE_NOT_FOUND`: with `reason: unknown_connector`, or `404 CONNECTOR_NOT_INSTALLED` when the project does not run the connector.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `422`: `VALIDATION_FAILED`: the payload broke a rule, and `error.fields` maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with `error.message` saying why and no `fields`.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)