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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: color, created_at, followers, followers.name, name, notes, permalink_url, workspace, workspace.name |
body | object | Required within parent | |
body.data | Model | Optional | Expand Create a tag — request body — body data |
Referenced models: Create a tag — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | Model | Optional | Expand Get a tag — response body — data data — Tag Response |
$ (allOf 2) | Model | All variants apply | Expand Get a tag — response body — data |
Referenced models: Get a tag — response body — data data — Tag Response, Get a tag — response body — data
Schemas
Section titled “Schemas”Get a tag — response body — data data — Tag Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a tag — response body — data data color, gid, name, notes, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
$ (allOf 2).followers | array | Optional | Array of users following this tag. Read only: true |
$ (allOf 2).followers[] | Model | Each item | Expand Get users in a team — response body — data data item |
$ (allOf 2).workspace | Model | Optional | Expand Update a workspace — request body — body data |
$ (allOf 2).permalink_url | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update a tag — request body — body data |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).followers | array | Optional | An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. |
$ (allOf 2).followers[] | string | Each item | |
$ (allOf 2).workspace | string | Optional | Gid 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a task's tags — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).color | JSON | Optional | |
$ (allOf 2).color (anyOf 1) | string | Alternative | Color 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) | null | Alternative | |
$ (allOf 2).notes | string | Optional | Free-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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | *Read-only except when same user as requester*. The user's name. |
Update a workspace — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Get a tag — response body — data data — sdk__Tag Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | 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. |
color | JSON | Optional | |
color (anyOf 1) | string | Alternative | Color 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) | null | Alternative | |
notes | string | Optional | Free-form textual information associated with the tag (i.e. its description). |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
followers | array | Optional | Array of users following this tag. Read only: true |
followers[] | Model | Each item | Expand Get an OOO entry — response body — data data user |
workspace | Model | Optional | Expand Get a tag — response body — data data workspace |
permalink_url | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a task's tags — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).color | JSON | Optional | |
$ (allOf 2).color (anyOf 1) | string | Alternative | Color 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) | null | Alternative | |
$ (allOf 2).notes | string | Optional | Free-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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *tag* is a label that can be attached to any task in Asana. It exists in a single workspace or organization. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | 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. |
Get an OOO entry — response body — data data user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | *Read-only except when same user as requester*. The user's name. |
Get a tag — response body — data data workspace
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]