> 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

# DeleteBranch

# Package: branches

# Namespace: BranchesService

# Method link: https://dev.wix.com/docs/api-reference/business-management/branches/delete-branch.md

## Permission Scopes:
Manage Site Branches: SCOPE.DC-DOCUMENT-MANAGEMENT.MANAGE-BRANCHES

## Introduction

Permanently deletes a branch.

---

## REST API

### Schema

```
 Method: deleteBranch
 Description: Permanently deletes a branch.
 URL: https://www.wixapis.com/branches/v1/branches/{branchId}
 Method: DELETE
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  branchId
 Method parameters: 
   param name: branchId | type:   none | required: true
 Return type: DeleteBranchResponse
  EMPTY-OBJECT {}

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: BRANCH_NOT_FOUND | Description: Couldn't find the branch.
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: FORBIDDEN_DELETE_ORIGINAL_BRANCH | Description: Can't delete the original branch.


```

### Examples

### Delete Branch
Deletes a branch

```curl
curl -X DELETE \
    'https://www.wixapis.com/branches/v1/branches/11111111-1111-1111-1111-111111111111' \
    -H 'Authorization: <AUTH>' \
    -H 'Content-Type: application/json' \
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.branches.BranchesService.deleteBranch(branchId)
 Description: Permanently deletes a branch.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  branchId
 Method parameters: 
   param name: branchId | type: string | description: GUID of the branch to delete. | required: true
 Return type: PROMISE<DeleteBranchResponse>
  EMPTY-OBJECT {}

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: BRANCH_NOT_FOUND | Description: Couldn't find the branch.
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: FORBIDDEN_DELETE_ORIGINAL_BRANCH | Description: Can't delete the original branch.


```

### Examples

### deleteBranch
```javascript
import { branches } from '@wix/editor-branches';

async function deleteBranch(branchId) {
  const response = await branches.deleteBranch(branchId);
};
```

### deleteBranch (with elevated permissions)
```javascript
import { branches } from '@wix/editor-branches';
import { auth } from '@wix/essentials';

async function myDeleteBranchMethod(branchId) {
  const elevatedDeleteBranch = auth.elevate(branches.deleteBranch);
  const response = await elevatedDeleteBranch(branchId);
}
```

### deleteBranch (self-hosted)
Self-hosted 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 { branches } from '@wix/editor-branches';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function deleteBranch(branchId) {
  const response = await myWixClient.branches.deleteBranch(branchId);
};
```

---