Skip to main content
POST
Create a custom integration-level category

Authorizations

X-Api-Key
string
header
required

Body

application/json

Schema for creating a custom category.

name
string
required

The name of the category (must be unique per integration / user).

Example:

"Kitchen Remodel"

parentId
string
required

The ID of the new category's parent. Can be a Spade category ID (e.g. "011-000-000-000") or a custom category ID (e.g. "e4cf5379-583f-44ed-b625-366044e666e6").

Example:

"011-000-000-000"

Response

Successful operation

The newly created category.

id
string

A unique identifier for this category.

Example:

"4d5419f1-bcde-40f5-9168-7f8989b9c55f"

name
string

The category's name

Example:

"Kitchen Remodel"

icon
string<url> | null

The category's icon, potentially inherited from the parent category.

Example:

"https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"

fullCategoryHierarchy
object[]

Array with increasingly specific category information.

Example: