Creates an item category.

Requires ManageInventory and an Idempotency-Key header. Same as "New Category" on the Item Categories page, with stricter checks: the name must be unique among the categories with the same parent, and the parent must be one of your categories that is neither the built-in "No Category" nor Template Builder-generated. The new category has no properties. Example: { "name": "Hardwood", "parentCategoryId": 1 }.

post/api/v1/categories

Request

Base URL: https://app.flexonthejob.com
URL: https://app.flexonthejob.com/api/v1/categories
Auth: HTTP bearer

Request body

namestring required

Category name, 1-100 characters (trimmed), unique among the categories with the same parent (case-insensitive), e.g. "Hardwood".

descriptionstring nullable

Optional description, at most 2000 characters; blank is stored as none.

parentCategoryIdinteger nullable

Parent category id (a category of your organization that is not Template Builder-generated), e.g. 1; omit, null or 0 for a top-level category.

Response

Created; body is the new category, Location points at it.

idinteger

Numeric category id, e.g. 4; the categoryId of items and the id used by /api/v1/categories/{id}/properties.

syncIdstring uuid

Globally unique sync id (GUID). Use it as the after pagination cursor.

namestring

Category name, e.g. "Lumber".

descriptionstring nullable

Optional description; null when unset.

parentCategoryIdinteger nullable

Id of the parent category; null for a top-level category.

isTemplateBuilderCategoryboolean

True when the category was generated by a Template Builder (its name and place in the tree are managed there, not on the Item Categories page).

createdAtstring date-time

UTC creation timestamp (ISO-8601).

updatedAtstring date-time nullable

UTC timestamp of the last edit of the category itself; null when never edited. Property changes do not move it.

Changes

No recorded changes to this operation across all 1 revision of this API.