Creating and Updating Tags

Creating a Tag

API Endpoint

Add a tag
POST /v1/teams/{teamId}/tagcategories/tags

URL Parameters

• teamId the ID of the Team which will be of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Request Headers

Along with all appropriate authentication headers, you must provide a Content-Type header with a value of application/json

Request Body

There are two required fields for creating a Tag.

• value the name of the Tag

• categoryId the ID of the Category that will contain the Tag

Sample Request

{
  "categoryId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "value":"My Tag"
}

Response

The response will include the value and categoryId that was sent in along with the id of the Tag that was created.

Sample Response

{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "categoryId" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "value" : "My Tag"
}

Updating a Tag

API Endpoint

Update a tag
PUT /v1/teams/{teamId}/tagcategories/tags/{tagId}

URL Parameters

• teamId the ID of the Team which will be of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

• tagId the ID of the Tag to update

Request Headers

Along with a appropriate authentication headers, you must provide a Content-Type header with a value of application/json

Request Body

There are two required fields for updating a Tag.

• value the name of the Tag

• categoryId the ID of the Category that will contain the Tag. The categoryId can be changed to move a Tag from one Category to another.

Sample Request

{
  "categoryId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "value":"My Updated Tag"
}

Response

The response will include the id, value and categoryId of the Tag that was updated.

Sample Response

{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "categoryId" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "value" : "My Updated Tag"
}