Unlinking accounts from users

The React SDK supports unlinking all supported account types via our modal-guided link methods. To prompt a user to unlink an account, use the respective method from the usePrivy hook:

Below is an example button for prompting a user to unlink certain linked accounts:

import {usePrivy} from '@privy-io/react-auth';

function LinkOptions() {
const {unlinkEmail, unlinkGoogle, unlinkWallet} = usePrivy();

return (
<div className="unlink-options">
<button onClick={unlinkEmail}>Unlink Email to user</button>
<button onClick={unlinkGoogle}>Unlink Google account to user</button>
<button onClick={unlinkWallet}>Unlink Wallet to user</button>
</div>
);
}

To prompt a user to unlink an account, use the respective functions and hooks:

Below is an example button for prompting a user to unlink an email from their account:

import {useUnlinkWallet} from '@privy-io/expo';

function LinkOptions() {
const {unlinkWallet} = useUnlinkAccount();

return (
<div className="unlink-options">
<button onClick={unlinkWallet}>Unlink Wallet to user</button>
</div>
);
}

Make a POST request to:

https://auth.privy.io/api/v1/apps/<privy-app-id>/users/unlink

Replace <privy-app-id> with your Privy app ID and pass in the following parameters:

​

Supported Account Types

The following account types can be unlinked via the API:

• email - Email accounts
• phone - Phone number accounts
• wallet - Externally connected wallets (Ethereum or Solana)
• smart_wallet - Smart contract wallets
• farcaster - Farcaster accounts
• telegram - Telegram accounts
• cross_app - Cross app accounts
• OAuth providers:
  • google_oauth
  • discord_oauth
  • twitter_oauth
  • github_oauth
  • linkedin_oauth
  • apple_oauth
  • spotify_oauth
  • instagram_oauth
  • tiktok_oauth

​

Example Requests

curl --request POST "https://auth.privy.io/api/v1/apps/<privy-app-id>/users/unlink" \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>" \
-H 'Content-Type: application/json' \
-d '{
  "user_id": "<user-did>",
  "type": "email",
  "handle": "[email protected]"
}'

​

Response

If the unlinking is successful, the API will return a 200 status code.

If there’s no account associated with the Privy DID that matches the type and handle, the API will return a 400 status code.

To unlink via the dashboard:

1. Navigate to the Users page
2. Select the user
3. Click the button beside the account you want to unlink
4. Click Unlink account