Tags

Manage vehicles and user categorization through unstructured tags.

Get List of Tags

Lists tags available in the account, including tags for Trips, Cars and Users. Tags are a free-form way to categorize things across an account.

GET

https://api.zubiecar.com/api/v2/zinc/tags

Sample response 200

{
  "tags": [
    {
      "color": "#CCCCCC",
      "key": "SampleKey",
      "type": "Car",
      "value": "Blue Cars"
    }
  ]
}

Create Tag

Create a new tag available for the whole account.

POST

https://api.zubiecar.com/api/v2/zinc/tags

Request Body Schema

Property	Type	Description
color	string	Hex color value used for tag display in app.
type	string	Type of tag. Must be Car, Trip or User.
value	string required	Group name.

Sample request body

{
  "color": "#CCCCCC",
  "type": "Car",
  "value": "At Risk Drivers"
}

Sample response 201

{
    "color": "#CCCCCC",
    "key": "agpzflj1BmllY2FyckILEgdBY2NvdW50IhZSRmRva5RrYTg0V0xVVGI5ZkhKM29iBfdsaA1RhZyIWNlM3a1c5TnBOd1VZSmtqYkhCUk1ISww",
    "type": "Car",
    "value": "At Risk Drivers"
}

Get a tag by key

Retrieve a specific tag.

GET

https://api.zubiecar.com/api/v2/zinc/tag/{tag_key}

Path Parameters

Property	Type	Description
tag_key	required	Unique tag key.

Sample response 200

{
  "color": "#CCCCCC",
  "key": "SampleKey",
  "type": "Car",
  "value": "Blue Cars"
}

Update Tag

Update a Tag name or color.

POST

https://api.zubiecar.com/api/v2/zinc/tag/{tag_key}

Path Parameters

Property	Type	Description
tag_key	required	Unique tag key.

Request Body Schema

Property	Type	Description
color	string	Hex color code of the tag.
value	string	Label for the tag.

Sample request body

{
  "color": "#CCCCCC",
  "value": "At Risk Drivers"
}

Apply Tag

Apply Tags to Trips, Cars or Users.

POST

https://api.zubiecar.com/api/v2/zinc/tag/{tag_key}/apply

Path Parameters

Property	Type	Description
tag_key	required	Unique tag key.

Request Body Schema

Property	Type	Description
action	string	Default: add Whether to add or remove the tag from entities.
entity_keys	Array of strings required	Must be valid keys associated with tag type Cars, Trips or Users.

Sample request body

{
  "action": "add",
  "entity_keys": [
    "SampleKey1",
    "SampleKey2"
  ]
}