API ReferenceConnected Accounts

Revoke a connected account at the providerv3.1

POST
/api/v3.1/connected_accounts/{nanoid}/revoke

Best-effort upstream revocation. On success, the connection transitions to REVOKED. Returns 400 when the toolkit does not support programmatic revocation, 409 when the connection is not in a revokable state, 500 when every upstream dispatch fails.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Path Parameters

nanoidstringRequired

The unique identifier of the connected account

Format: connectedAccountId

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v3.1/connected_accounts/ca_1a2b3c4d5e6f/revoke"
{  "revoked_tokens": [    "access_token",    "refresh_token"  ],  "connected_account": {    "id": "ca_1a2b3c4d5e6f",    "status": "REVOKED"  }}
Edit this page on GitHub