Skip to main content
Docs

deleteUserExternalAccount()

Deletes a user's external account by ID. Returns a .

function deleteUserExternalAccount(
  params: DeleteUserExternalAccountParams,
): Promise<DeletedObjectResource>

DeleteUserExternalAccountParams

  • Name
    userId
    Type
    string
    Description

    The ID of the user to delete the external account for.

  • Name
    externalAccountId
    Type
    string
    Description

    The ID of the external account to delete.

Example

Note

Importing clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const userId = 'user_123'
const externalAccountId = 'external_account_123'

const response = await clerkClient.users.deleteUserExternalAccount({
  userId,
  externalAccountId,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/users/{user_id}/external_accounts/{external_account_id}. See the BAPI reference for more information.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on