Sign in
Tags

Create a tag

<b>Required scope: </b><code>tags:write</code>

Creates a new tag in a workspace or organization.

Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization.

Returns the full record of the newly created tag.

post/tags

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/tags
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token, scopes: tags:write)

Query parameters

opt_fieldsstring[]

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. Properties can include nested fields. To learn more, see the input/output options guide.

Request body

Example request

{
  "data": {
    "gid": "12345",
    "resource_type": "tag",
    "name": "Stuff to buy",
    "color": "light-green",
    "notes": "Mittens really likes the stuff from Humboldt.",
    "followers": [
      "12345",
      "42563"
    ],
    "workspace": "12345"
  }
}

Response

Successfully created the newly specified tag.

Example response

{
  "data": {
    "gid": "12345",
    "resource_type": "tag",
    "name": "Stuff to buy",
    "color": "light-green",
    "notes": "Mittens really likes the stuff from Humboldt.",
    "created_at": "2012-02-22T02:06:58.147Z",
    "followers": [
      {
        "gid": "12345",
        "resource_type": "user",
        "name": "Greg Sanchez"
      }
    ],
    "workspace": {
      "gid": "12345",
      "resource_type": "workspace",
      "name": "My Company Workspace"
    },
    "permalink_url": "https://app.asana.com/0/resource/123456789/list"
  }
}

Changes

No operation changes recorded.