v1

latestOpenAPI 3.0.4Derdack GmbH2026-07-13113141479.8 KB
Categories

Create a new category

Sample Request:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}
post/categories/{teamId}

Path parameters

teamIdstring required

ID of the team the category belongs to

Request body

idstring nullable
teamIdstring nullable
isDefaultboolean
options0 | 1 | 2 | 4 | 8
namestring required
colorstring required
imageNamestring required
keywordsstring[] required
keywordsExcludedstring[] nullable
keywordMatching0 | 1 required
orderinteger

Response

Returns the newly created category

idstring nullable
teamIdstring nullable
isDefaultboolean
options0 | 1 | 2 | 4 | 8
namestring required
colorstring required
imageNamestring required
keywordsstring[] required
keywordsExcludedstring[] nullable
keywordMatching0 | 1 required
orderinteger