Sign in
Connected Accounts
Authentication

Re-initiate authentication for a connected account (DEPRECATED)

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.

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

Path parameters

nanoidstring connectedAccountId required

The unique identifier of the connected account

Query parameters

redirect_urlstring uri

Request body

redirect_urlstring uri
validate_credentialsboolean

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

Response

Successfully refreshed the connected account authentication. For OAuth flows, a new redirect URL is provided.

idstring required

The unique identifier of the connected account

status'INITIALIZING' | 'INITIATED' | 'ACTIVE' | 'FAILED' | 'EXPIRED' | 'INACTIVE' | 'REVOKED' required

The current status of the connected account (e.g., active, pending, failed)

redirect_urlstring nullable required

The URL to which the user should be redirected to complete the authentication process (null for auth schemes that do not require redirection)

Example response

{
  "id": "ca_1a2b3c4d5e6f",
  "status": "ACTIVE",
  "redirect_url": "https://app.example.com/oauth/callback"
}

Changes

Changed in 5 of the 61 revisions of this API.14