Delete a connected account
Soft-deletes a connected account by marking it as deleted in the database. This prevents the account from being used for API calls but preserves the record for audit purposes. Pass ?revoke_on_delete=true to also revoke the account's upstream credentials via a background job.
Path parameters
The unique identifier (nanoid) of the connected account
Query parameters
When true, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a revoke_job_id. Defaults to false. Revocation is irreversible — recovering a deleted entity does not restore working credentials.
When true, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a revoke_job_id. Defaults to false. Revocation is irreversible — recovering a deleted entity does not restore working credentials.
Response
Successfully deleted the connected account. The account is marked as deleted but retained in the database for historical purposes.
Example response
{
"success": true
}Changes
Changed in 2 of the 61 revisions of this API.4
- ○
the endpoint scheme security
CookieAuthwas removed from the APIapi-security-removed
- ○
added the new optional
queryrequest parameterrevoke_on_deletenew-optional-request-parameter
- ○
added the optional property
to the response with the statusresponse-optional-property-added
- ○
- ○
endpoint added
endpoint-added
- ○