API REFERENCE

Disconnect Connector

On this page

DELETE/api/connectors

Disconnect a connected account from a third-party service. This revokes the OAuth connection and removes stored credentials.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL

curl --request DELETE \
  --url 'https://api.recoupable.dev/api/connectors' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "connected_account_id": "string"
}'

Try it

Fill in the fields, send the request from your browser, and read the live response. The curl below updates as you type.

API keyx-api-key header

Kept in this browser tab only and cleared when it closes.

Request bodyapplication/json

cURL for this request

curl --request DELETE \
  --url 'https://recoup-api.vercel.app/api/connectors' \
  --header 'Content-Type: application/json' \
  --data '{
  "connected_account_id": "string"
}'

Request body required

Connection to disconnect

application/json

connected_account_idstringrequired

The connected account ID to disconnect (from ConnectorInfo.connectedAccountId)

account_idstring

Optional account ID when disconnecting a connection that belongs to a different account (e.g., an artist). Required when the connection was created for another account rather than your own. The authenticated account must have access.

format: uuid

Responses

200Connector disconnected successfully

application/json

successbooleanrequired

messagestring

Status message

400Bad request - missing or invalid parameters

application/json

errorintegerrequired

format: int32

messagestringrequired

401Unauthorized - invalid or missing API key

application/json

errorintegerrequired

format: int32

messagestringrequired

403Forbidden - no access to the specified account or connection

application/json

errorintegerrequired

format: int32

messagestringrequired

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download social.json

View operation source

json

{
  "security": [
    {
      "apiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "description": "Disconnect a connected account from a third-party service. This revokes the OAuth connection and removes stored credentials.",
  "requestBody": {
    "description": "Connection to disconnect",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/DisconnectConnectorRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Connector disconnected successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/DisconnectConnectorResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad request - missing or invalid parameters",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized - invalid or missing API key",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden - no access to the specified account or connection",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}