Sample - Asana API
PUT/tags/{tag_gid}

Update a tag

Updates the properties of an existing tag. Supply only the fields you want to change in data; unspecified fields remain unchanged, which helps you avoid overwriting changes made by another user. The response contains the complete updated tag record.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
opt_fieldsarray<string>optional
Comma-separated fields to include in the response, including color, created_at, followers, followers.name, name, notes, permalink_url, workspace, or workspace.name.

The tag properties to update, supplied in the data object. Include only the fields you want to change.

dataobjectoptional
The tag properties to update, such as name, color, or notes. Fields omitted from `data` retain their current values.

6 status codes
200Returns the complete updated tag record.
dataobjectoptional
400Returned when a request parameter or body value is missing or malformed.
errorsarray<object>optional
401Returned when a valid authentication token was not provided with the request.
errorsarray<object>optional
403Returned when the authenticated user does not have access to update the tag or its specified properties.
errorsarray<object>optional
404Returned when the request action is unknown or the specified tag does not exist.
errorsarray<object>optional
500Returned when a server-side problem prevents the request from completing.
errorsarray<object>optional

Error handling

A 400 is returned when a parameter or request body value is missing or malformed. A 401 is returned without valid authentication, and a 403 is returned when the authenticated user cannot update the tag. A 404 indicates that the tag or requested action does not exist, while a 500 indicates a server-side failure; the caller must also have the tags:write scope and use data for the fields to update.