Delete Branch

Production

DELETE

/delete/branch/{id}

Deletes a branch by id.

This is a v2 native-entity endpoint served from the /v2/api/entity base and authenticated with a Bearer token. Requires the Branches plugin to be enabled on the account.

The branch id is given in the path. On success the response is { "message": <localized text> }.

Request

Path Params

Header Params

Responses

🟢200Success

application/json

The branch was deleted.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/delete/branch/3' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "message": "Branch deleted successfully"
}

Edit Branch

Add Product bundle