Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
tag

Add Tag

Creates a new tag

post/tag/add

Request body

namestring required

Tag name

type'orders' | 'items' | 'purchase_order' | 'customers' required

Tag type

color'red' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'indigo' | 'gray' | 'maroon' | 'fuchsia' | 'chartreuse' | 'dodger' | 'salmon' | 'cornflower' | 'khaki' | 'steel' | 'plum'

Tag color

Example request

{
  "name": "Priority"
}

Response

Tag created or existing tag returned

successboolean required

Whether the tag was newly created (false if preexisting)

_idstring required

Tag ID (new or existing)

namestring required

Tag name

type'orders' | 'items' | 'purchase_order' | 'customers'

Tag type

preexistingboolean

True if a tag with this name and type already existed

Example response

{
  "_id": "507f1f77bcf86cd799439011"
}