Update a tag

PATCH

/v2/tags/:tagId

Update the description of a specific version tag. Retrieve the tagId by calling the /v2/tags endpoint and using the versionTagId in the response.

Update the description of a specific version tag. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

tagIdstringRequired

Request

The request body.

descriptionstringOptional

Description of the version tag.

Response

The response body.

versionTagIdstring

namestring

ownerIdstring

createdBystring

The identifier of the user who created this object.

updatedBystring

The identifier of the user or process that last updated this object.

createdAtdatetime

When the object was created.

updatedAtdatetime

When the object was last updated.

isArchivedboolean

descriptionstring

colorenum

$	curl -X PATCH https://api.sigmacomputing.com/v2/tags/tagId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"versionTagId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"name": "Release 2024 Q1",
4	"ownerId": "user_987654321",
5	"createdBy": "user_123456789",
6	"updatedBy": "user_123456789",
7	"createdAt": "2024-01-15T09:30:00Z",
8	"updatedAt": "2024-01-15T09:30:00Z",
9	"isArchived": false,
10	"description": "Updated description for the Q1 release tag to reflect recent changes.",
11	"color": "cyan"
12	}