Skip to main content
POST
/
api-category
/
v1
/
category
Create category
curl --request POST \
  --url https://live.copilot.fabric.inc/api-category/v1/category \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "name": "notes",
  "active": true,
  "parentNodeId": 1,
  "order": 3,
  "type": "ALTERNATE"
}
'
{
  "id": "6170135a49b4af38190970fe",
  "nodeId": 12,
  "name": "Furniture",
  "createdOn": "2021-12-01T00:00:00.000Z",
  "modifiedOn": "2021-12-01T00:00:00.000Z",
  "attributes": [
    {}
  ],
  "children": [
    {}
  ],
  "breadcrumbs": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

S2S access token (JWT) from fabric Identity service (during Login)

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json
​
name
string
required

Category name

Example:

"notes"

​
active
boolean

true: Category is Active
false: Category is Inactive
Note: When type is Primary, status must be Active. Inactive status is not applicable for Primary category.

Example:

true

​
parentNodeId
number

Numeric ID of parent category. If omitted, new category is created under the root category.

Example:

1

​
order
number

The order in which this child category appears among the sibling categories (of the same parent).
Note:
1) Applicable only for children categories.
2) Order 0 means this child category appears at the beginning of other sibling categories.
3) Unless order is specified, the child category appears at the end.

Example:

3

​
type
enum<string>

Category type. Specify this field to create a new root category. Applicable only if parentNodeId is omitted.

Available options:
ALTERNATE,
PRIMARY

Response

OK

​
id
string

A 24-character system-generated category ID. nodeId and id are the two identifier of a category, and one of them must be specified.

Example:

"6170135a49b4af38190970fe"

​
nodeId
number

Numeric category ID. nodeId and id are the two identifier of a category, and one of them must be specified.

Example:

12

​
name
string

Category name

Example:

"Furniture"

​
createdOn
string

Time of category creation (UTC format)

Example:

"2021-12-01T00:00:00.000Z"

​
modifiedOn
string

Time when category was last updated (UTC format)

Example:

"2021-12-01T00:00:00.000Z"

​
attributes
object[]
​
children
object[]
​
breadcrumbs
object[]

Path of categories leading to root of category