Reconnects an existing connection in place. On OAuth platforms it starts a fresh sign-in and returns the connection with a new authorisation URL to send the browser to; on API-key platforms pass the fresh key as 'apiKey' and it is validated live onto the same row. Use this for "Reconnect" rather than creating a connection: the row keeps its code, so documents, folder mappings, client books links and bookkeeping health links stay attached, and platforms whose refresh token rotates never end up with two rows holding one grant. On document storage platforms creating a connection also continues the existing one, and a different account must still reach the practice's files or the sign-in is refused. To move anyway, remove the connection first, which detaches its documents and client folders.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| code* | path string | |
Request Body
{
"redirectUrl": "string",
"apiKey": "string",
"useExtendedScopes": false
}