API reference / Depository / Broker
Revoke connection
Revoke a linked account and hard-delete its vaulted credentials.
DELETE
/v1/broker/connections/:id- Authentication
- Bearer token
- Scope
broker:write
Before you integrate
- Permanent: the stored credentials are deleted. Link the account again to use it later.
Path parameters
| Field | Type | Description |
|---|---|---|
id | string | The connection_id to remove. |
Sample code
Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.
curl -sS -X DELETE 'https://grappi.ai/v1/broker/connections/bconn_...' \ -H "Authorization: Bearer $GRAPPI_API_KEY"
Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"connection_id": "bconn_a1b2c3d4e5f60718",
"status": "revoked"
}
}Response fields
| Field | Type | Description |
|---|---|---|
connection_id | string | The connection's id. |
status | string | revoked. |
Errors
Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.