Docs

deleteRedirectUrl()

Deletes a redirect URL, given a valid ID.

function deleteRedirectUrl: (redirectUrlId: string) => Promise<RedirectUrl>;
  • Name
    redirectUrlId
    Type
    string
    Description

    The ID of the redirect URL to delete.

const redirectUrlId = 'ru_2bxLHVfYsA13r8iKHWoY8SAr9az';

const response = await clerkClient.redirectUrls.deleteRedirectUrl(redirectUrlId);

console.log(response);
/*
_DeletedObject {
  object: 'redirect_url',
  id: 'ru_2bxLHVfYsA13r8iKHWoY8SAr9az',
  slug: null,
  deleted: true
}
*/

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/redirect_urls/{id}. See the BAPI reference for more details.

Feedback

What did you think of this content?