XPipe LogoXPipe Documentation

Remove categories

Removes a set of categories. This can include any possible children categories and connections associated with the category. Some categories, for example the root categories, can not be removed.

POST
/category/remove

Authorization

AuthorizationRequiredBearer <token>

The bearer token used is the session token that you receive from the handshake exchange.

In: header

Request Body

application/jsonRequired
categoriesRequiredarray<string>

The categories to remove

removeChildrenCategoriesRequiredboolean

Whether to also remove any children categories

removeContentsRequiredboolean

Whether to also remove any connection entries in the categories. If this is false, any connections are moved to the default category instead.

curl -X POST "http://localhost:21721/category/remove" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": [
      "36ad9716-a209-4f7f-9814-078d3349280c"
    ]
  }'

The removal was successful.