API ReferenceConnected Accounts

Re-initiate authentication for a connected accountv3.1Legacy

Deprecated

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

DEPRECATED: This endpoint re-initiates the authorization flow for a connected account — a developer-triggered reconnection (e.g. to recover a connection whose credentials expired or became invalid), returning a new OAuth redirect URL where applicable. It does NOT perform background credential auto-refresh; the "refresh" name was misleading, which is why the endpoint is deprecated and may be removed in a future release.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Path Parameters

nanoidstringRequired

The unique identifier of the connected account

Format: connectedAccountId

Query Parameters

redirect_urlstring
Format: uri

Request Body

application/json

redirect_urlstring
Format: uri
validate_credentialsbooleanExperimental

Whether to validate the provided credentials, validates only for API Key Auth scheme

Default: false

Response Body

application/json

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/refresh" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "ca_1a2b3c4d5e6f",  "status": "ACTIVE",  "redirect_url": "https://app.example.com/oauth/callback"}
Edit this page on GitHub