Add Tag

Creates a new tag

POST /tag/add

Add Tag

cURL

curl --request POST \
  --url https://api.skulabs.com/tag/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Priority",
  "type": "orders",
  "color": "red"
}
'

200

{
  "success": true,
  "_id": "507f1f77bcf86cd799439011",
  "name": "<string>",
  "type": "orders",
  "preexisting": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Tag name

Example:

"Priority"

type · enum<string> · required

Tag type

Available options: orders, items, purchase_order, customers

color · enum<string>

Tag color

Available options: red, orange, yellow, green, blue, purple, indigo, gray, maroon, fuchsia, chartreuse, dodger, salmon, cornflower, khaki, steel, plum

Response

200

application/json

Tag created or existing tag returned

success · boolean · required

Whether the tag was newly created (false if preexisting)

_id · string · required

Tag ID (new or existing)

Example:

"507f1f77bcf86cd799439011"

name · string · required

Tag name

type · enum<string>

Tag type

Available options: orders, items, purchase_order, customers

preexisting · boolean

True if a tag with this name and type already existed