tag

Add Tag

Changed on

Creates a new tag

post/tag/add

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/tag/add
  • Auth
    HTTP bearer

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"
}

Changes

  • fa53dd949b8eRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      api operation id post_tag_add was added

    • info

      added the new blue enum value to the request property

    • info

      added the new chartreuse enum value to the request property

    • info

      added the new cornflower enum value to the request property

    • info

      added the new customers enum value to the request property

    • info

      added the new dodger enum value to the request property

    • info

      added the new fuchsia enum value to the request property

    • info

      added the new gray enum value to the request property

    • info

      added the new green enum value to the request property

    • info

      added the new indigo enum value to the request property

    • info

      added the new khaki enum value to the request property

    • info

      added the new maroon enum value to the request property

    • info

      added the new orange enum value to the request property

    • info

      added the new plum enum value to the request property

    • info

      added the new purple enum value to the request property

    • info

      added the new red enum value to the request property

    • info

      added the new salmon enum value to the request property

    • info

      added the new steel enum value to the request property

    • info

      added the new yellow enum value to the request property

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 3b410dd1cc4bRevision changes
    • breaking

      removed the enum value item of the request property

    • breaking

      removed the enum value order of the request property

    • info

      added the new items enum value to the request property

    • info

      added the new orders enum value to the request property

    • info

      added the new purchase_order enum value to the request property