Update a tag

Updates the properties of a tag. Only the fields provided in the data
block will be updated; any unspecified fields will remain unchanged.

When using this method, it is best to specify only those fields you wish
to change, or else you may overwrite changes made by another user since
you last retrieved the tag.

Returns the complete updated tag record.

Path Params
string
required

Globally unique identifier for the tag.

Query Params
array of strings

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

opt_fields
boolean

Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

Body Params

The tag to update.

object

A tag is a label that can be attached to any task in Asana. It exists in a single workspace or organization.

Responses

Response body
object
object

A tag is a label that can be attached to any task in Asana. It exists in a single workspace or organization.

string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.

string | null

Color of the tag.

dark-pink dark-green dark-blue dark-red dark-teal dark-brown dark-orange dark-purple dark-warm-gray light-pink light-green light-blue light-red light-teal light-brown light-orange light-purple light-warm-gray

string

Free-form textual information associated with the tag (i.e. its description).

date-time

The time at which this resource was created.

array of objects

Array of users following this tag.

followers
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

Read-only except when same user as requester. The user’s name.

object

A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.

string

Language
Credentials
Request
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.