API ReferenceConnected Accounts

Refresh authentication for a connected account

Initiates a new authentication flow for a connected account when credentials have expired or become invalid. This may generate a new authentication URL for OAuth flows or refresh tokens for other auth schemes.

Authentication

x-api-keystring
API key authentication

Path parameters

nanoidstringRequiredformat: "connectedAccountId"
The unique identifier of the connected account

Query parameters

redirect_urlstringOptional

Request

This endpoint expects an object.
redirect_urlstringOptional
validate_credentialsbooleanOptionalDefaults to false

[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
The unique identifier of the connected account
statusenum

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

redirect_urlstring or null

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

Errors