Connections

Force disable connection

post
https://api.snaptrade.com/api/v1/authorizations/{authorizationId}/disable

Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection.

Please contact us in order to use this endpoint as it is disabled by default.

Execute an API Request

Path
authorizationIdstring (format: uuid)required

Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.

Query
userIdstringrequired

SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

userSecretstringrequired

SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.

Authorization
Request
Installation
$
npm install snaptrade-typescript-sdk
1
Loading...

Response fields

object

Confirmation that the connection has been disabled.

detailstring

Connection disabled confirmation

1
{
2
"detail": "Connection 0b3ebefb-ed47-43df-cd8f-729a4420b5cf has been disabled"
3
}