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

bearerAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

categories*array<string>

The categories to remove

removeChildrenCategories*boolean

Whether to also remove any children categories

removeContents*boolean

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

Response Body

application/json

application/json

curl -X POST "http://localhost:21721/category/remove" \  -H "Content-Type: application/json" \  -d '{    "categories": [      "36ad9716-a209-4f7f-9814-078d3349280c"    ]  }'
Empty
{
  "message": "string"
}
Empty
Empty
{
  "error": {
    "cause": {},
    "stackTrace": [],
    "suppressed": [],
    "localizedMessage": "string",
    "message": "string"
  }
}