Accounts

Bulk delete financial accounts

Deletes multiple financial accounts in one request. Returns a per-account result indicating success or failure, so a partial failure does not fail the whole request. Deleting an account also deletes all of its associated data, like balances, holdings, transactions, and transfer links.

POST

/finance/accounts/bulk-delete

curl --request POST \
  --url https://api.synci.io/api/v1/finance/accounts/bulk-delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountIds": [
    123
  ]
}
'

{
  "data": {
    "deleted_count": 123,
    "failed_count": 123,
    "results": [
      {
        "account_id": "<string>",
        "message": "Financial account deleted.",
        "name": "<string>",
        "success": true
      }
    ]
  },
  "message": "Bulk delete completed."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

accountIdsinteger[]required

The IDs of the financial accounts to delete. Only accounts belonging to the authenticated user will be deleted.

Required array length: 1 - 100

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team