Tags

Add tags to inventory

post

Authorizations

ApiKey

AuthorizationstringRequired

Prefix the value with "ApiKey" to indicate the custom authorization type

Path parameters

inventoryIdstring · uuidRequired

The Inventory ID to add the tags to

Example: 123e4567-e89b-12d3-a456-426614174000

Body

application/json

Request body

labelsstring[]Required

Set of labels to be added as tags

Example: ["Tag 1","Tag 2"]

Responses

200

Tags added successfully

application/json

400

Bad request

application/json

403

Forbidden

*/*

404

Inventory not found

application/json

409

Tag already exists for the inventory

application/json

post

/api/inventory/{inventoryId}/tags

HTTPcURLJavaScriptPython

POST /api/inventory/{inventoryId}/tags HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "labels": [
    "Tag 1",
    "Tag 2"
  ]
}

[
  {
    "id": "8e0caa73-cc71-4aa4-88eb-fca494de8e20",
    "label": "Engineering"
  }
]

Remove tag from inventory

delete

Authorizations

ApiKey

AuthorizationstringRequired

Prefix the value with "ApiKey" to indicate the custom authorization type

Path parameters

inventoryIdstring · uuidRequired

The Inventory ID to remove the tag from

Example: 123e4567-e89b-12d3-a456-426614174000

tagIdstring · uuidRequired

The Tag ID to remove

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Tag successfully removed from inventory

application/json

400

Bad request

application/json

403

Forbidden

*/*

404

Inventory or Tag not found

application/json

delete

/api/inventory/{inventoryId}/tags/{tagId}

HTTPcURLJavaScriptPython

DELETE /api/inventory/{inventoryId}/tags/{tagId} HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "8e0caa73-cc71-4aa4-88eb-fca494de8e20",
  "label": "Engineering"
}