> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# DeleteUrlMapping

# Package: seo

# Namespace: UrlMappingWriterService

# Method link: https://dev.wix.com/docs/api-reference/business-management/seo/url-mapping-v1/delete-url-mapping.md

## Permission Scopes:
Manage SEO Settings: SCOPE.PROMOTE.MANAGE-SEO

## Introduction

Deletes the URL mapping for one type of item page.

The item pages go back to their default URL. The change is live on the site right
away. On a published site, the old URLs stop working, so create redirects from them with
[Bulk Create Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/bulk-create-redirects.md).

---

## REST API

### Schema

```
 Method: deleteUrlMapping
 Description: Deletes the URL mapping for one type of item page.  The item pages go back to their default URL. The change is live on the site right away. On a published site, the old URLs stop working, so create redirects from them with [Bulk Create Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/bulk-create-redirects.md).
 URL: https://www.wixapis.com/url-mapper/writer/v1/url-mapping/{key}
 Method: DELETE
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  key
 Method parameters: 
   param name: key | type:   none | required: true 
 Return type: DeleteUrlMappingResponse
  - name: urlMapping | type: UrlMapping | description: Deleted URL mapping.  
     - name: key | type: string | description: Type of item page this URL mapping applies to, and the variables its `mapping` must use: + `wix.stores.sub_pages.product`: Stores product page. Variables: `slug`. + `wix.blog.sub_pages.post`: Blog post page. Variables: `slug`. + `wix.blog.sub_pages.category`: Blog category page. Variables: `slug`. + `wix.bookings.sub_pages.service_page`: Bookings service page. Variables: `slug`. + `wix.online_programs.sub_pages.online_program`: Online Programs program page. Variables: `slug`. + `wix.forum.sub_pages.category`: Forum category page. Variables: `slug`. + `wix.forum.sub_pages.post`: Forum post page. Variables: `categorySlug`, `postSlug`. + `wix.groups.sub_pages.group`: Groups group page. Variables: `groupId`, `tabName`.  Other values aren't supported.  
     - name: mapping | type: string | description: URL pattern for the item pages, relative to the site's base URL. Wrap variables in double curly braces, for example `shoes/{{slug}}`. The pattern must use every variable listed for its `key`, and no others. The pattern is saved in lowercase.  Rules: up to 1,000 characters; no spaces, emoji, or URL-reserved characters; no leading or trailing slash; no empty segments; at most one variable per segment. The resulting URLs can't collide with another page on the site or with another URL mapping.  

 Possible Errors:
   HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code:  | Description: The `key` isn't supported. Details are in `fieldViolations`.
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: URL_MAPPER_NOT_FOUND | Description: Couldn't find the URL mapping for the `key`.
   HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: URL_MAPPER_SAVE_CONFLICT | Description: Another write to the site's URL mappings happened at the same time. Nothing is deleted. Retry.


```

### Examples

### Delete the URL mapping for Stores product pages
Product pages go back to the default URL. The response returns the deleted URL mapping.

```curl
curl -X DELETE \
'https://www.wixapis.com/url-mapper/writer/v1/url-mapping/wix.stores.sub_pages.product' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.seo.urlMappings.deleteUrlMapping(key)
 Description: Deletes the URL mapping for one type of item page.  The item pages go back to their default URL. The change is live on the site right away. On a published site, the old URLs stop working, so create redirects from them with [Bulk Create Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/bulk-create-redirects.md).
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  key
 Method parameters: 
   param name: key | type: string | description: Type of item page whose URL mapping to delete. | required: true 
 Return type: PROMISE<DeleteUrlMappingResponse>
  - name: urlMapping | type: UrlMapping | description: Deleted URL mapping.  
     - name: key | type: string | description: Type of item page this URL mapping applies to, and the variables its `mapping` must use: + `wix.stores.sub_pages.product`: Stores product page. Variables: `slug`. + `wix.blog.sub_pages.post`: Blog post page. Variables: `slug`. + `wix.blog.sub_pages.category`: Blog category page. Variables: `slug`. + `wix.bookings.sub_pages.service_page`: Bookings service page. Variables: `slug`. + `wix.online_programs.sub_pages.online_program`: Online Programs program page. Variables: `slug`. + `wix.forum.sub_pages.category`: Forum category page. Variables: `slug`. + `wix.forum.sub_pages.post`: Forum post page. Variables: `categorySlug`, `postSlug`. + `wix.groups.sub_pages.group`: Groups group page. Variables: `groupId`, `tabName`.  Other values aren't supported.  
     - name: mapping | type: string | description: URL pattern for the item pages, relative to the site's base URL. Wrap variables in double curly braces, for example `shoes/{{slug}}`. The pattern must use every variable listed for its `key`, and no others. The pattern is saved in lowercase.  Rules: up to 1,000 characters; no spaces, emoji, or URL-reserved characters; no leading or trailing slash; no empty segments; at most one variable per segment. The resulting URLs can't collide with another page on the site or with another URL mapping.  

 Possible Errors:
   HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code:  | Description: The `key` isn't supported. Details are in `fieldViolations`.
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: URL_MAPPER_NOT_FOUND | Description: Couldn't find the URL mapping for the `key`.
   HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: URL_MAPPER_SAVE_CONFLICT | Description: Another write to the site's URL mappings happened at the same time. Nothing is deleted. Retry.


```

### Examples

### deleteUrlMapping
```javascript
import { urlMappings } from '@wix/seo';

async function deleteUrlMapping(key) {
  const response = await urlMappings.deleteUrlMapping(key);
};
```

### deleteUrlMapping (with elevated permissions)
```javascript
import { urlMappings } from '@wix/seo';
import { auth } from '@wix/essentials';

async function myDeleteUrlMappingMethod(key) {
  const elevatedDeleteUrlMapping = auth.elevate(urlMappings.deleteUrlMapping);
  const response = await elevatedDeleteUrlMapping(key);
}
```

### deleteUrlMapping (self-managed)
Self-managed SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { urlMappings } from '@wix/seo';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { urlMappings },
  // Include the auth strategy and host as relevant
});


async function deleteUrlMapping(key) {
  const response = await myWixClient.urlMappings.deleteUrlMapping(key);
};
```

---