Skip to content

Asana: Create a tag

Asana tags.createTag: arguments, response, policy and SDK examples.

← Tags operations · Get started

Operation asana.createtag

Provider route: POST /tags. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["tags"]["createTag"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.tags.createTag(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_asana import AsanaIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.tags.create_tag(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: color, created_at, followers, followers.name, name, notes, permalink_url, workspace, workspace.name
bodyobjectRequired within parent
body.dataModelOptionalExpand Create a tag — request body — body data

Referenced models: Create a tag — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Get a tag — response body — data data — Tag Response
$ (allOf 2)ModelAll variants applyExpand Get a tag — response body — data

Referenced models: Get a tag — response body — data data — Tag Response, Get a tag — response body — data

Get a tag — response body — data data — Tag Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a tag — response body — data data color, gid, name, notes, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).followersarrayOptionalArray of users following this tag.
Read only: true
$ (allOf 2).followers[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).workspaceModelOptionalExpand Update a workspace — request body — body data
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true

Referenced models: Get a tag — response body — data data color, gid, name, notes, resource type, Get users in a team — response body — data data item, Update a workspace — request body — body data

Get a tag — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a tag — response body — data data — sdk__Tag Response

Referenced models: Get a tag — response body — data data — sdk__Tag Response

Create a tag — request body — body data
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update a tag — request body — body data
$ (allOf 2)objectAll variants apply
$ (allOf 2).followersarrayOptionalAn array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
$ (allOf 2).followers[]stringEach item
$ (allOf 2).workspacestringOptionalGid of an object.

Referenced models: Update a tag — request body — body data

Get a tag — response body — data data color, gid, name, notes, resource type
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a task's tags — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).colorJSONOptional
$ (allOf 2).color (anyOf 1)stringAlternativeColor of the tag.
Known values: 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
$ (allOf 2).color (anyOf 2)nullAlternative
$ (allOf 2).notesstringOptionalFree-form textual information associated with the tag (i.e. its description).

Referenced models: Get a task's tags — response body — data, next page data item

Get users in a team — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.
Update a workspace — request body — body data
FieldTypePresenceDescription and constraints
$objectRootA *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.
Get a tag — response body — data data — sdk__Tag Response
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *tag* is a label that can be attached to any task in Asana. It exists in a single workspace or organization.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName 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.
colorJSONOptional
color (anyOf 1)stringAlternativeColor of the tag.
Known values: 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
color (anyOf 2)nullAlternative
notesstringOptionalFree-form textual information associated with the tag (i.e. its description).
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
followersarrayOptionalArray of users following this tag.
Read only: true
followers[]ModelEach itemExpand Get an OOO entry — response body — data data user
workspaceModelOptionalExpand Get a tag — response body — data data workspace
permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true

Referenced models: Get an OOO entry — response body — data data user, Get a tag — response body — data data workspace

Update a tag — request body — body data
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a task's tags — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).colorJSONOptional
$ (allOf 2).color (anyOf 1)stringAlternativeColor of the tag.
One of: 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, null
$ (allOf 2).color (anyOf 2)nullAlternative
$ (allOf 2).notesstringOptionalFree-form textual information associated with the tag (i.e. its description).

Referenced models: Get a task's tags — response body — data, next page data item

Get a task's tags — response body — data, next page data item
FieldTypePresenceDescription and constraints
$objectRootA *tag* is a label that can be attached to any task in Asana. It exists in a single workspace or organization.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName 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.
Get an OOO entry — response body — data data user
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.
Get a tag — response body — data data workspace
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.

SDK function policy ID: asana.createtag. Catalog operation: asana:createTag. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["tags:write"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.