Asana: Update a project brief
Asana projectBriefs.updateProjectBrief: arguments, response, policy and SDK examples.
← Project briefs operations · Get started
Operation asana.updateprojectbrief
Provider route: PUT /project_briefs/{project_brief_gid}. 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["projectBriefs"]["updateProjectBrief"]>[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.projectBriefs.updateProjectBrief(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.project_briefs.update_project_brief(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.project_brief_gid | string | Required within parent | |
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: html_text, permalink_url, project, project.name, project.resource_subtype, text, title |
body | object | Required within parent | |
body.data | Model | Optional | Expand Create a project brief — request body — body data |
Referenced models: Create a project brief — 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 project brief — response body — data data — Project Brief Response |
$ (allOf 2) | Model | All variants apply | Expand Get a project brief — response body — data |
Referenced models: Get a project brief — response body — data data — Project Brief Response, Get a project brief — response body — data
Schemas
Section titled “Schemas”Get a project brief — response body — data data — Project Brief Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a project brief — response body — data data gid, html text, resource type, title |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).text | string | Optional | [Opt In](/docs/inputoutput-options). The plain text of the project brief. |
$ (allOf 2).permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
$ (allOf 2).project | JSON | Optional | |
$ (allOf 2).project (allOf 1) | Model | All variants apply | Expand Search projects in a workspace — response body — data data item |
$ (allOf 2).project (allOf 2) | object | All variants apply | The project with which this project brief is associated. |
Referenced models: Get a project brief — response body — data data gid, html text, resource type, title, Search projects in a workspace — response body — data data item
Get a project brief — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a project brief — response body — data data — sdk__Project Brief Response |
Referenced models: Get a project brief — response body — data data — sdk__Project Brief Response
Create a project brief — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a project brief — response body — data data gid, html text, resource type, title |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).text | string | Optional | The plain text of the project brief. When writing to a project brief, you can specify either `html_text` (preferred) or `text`, but not both. |
Referenced models: Get a project brief — response body — data data gid, html text, resource type, title
Get a project brief — response body — data data gid, html text, resource type, title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a project brief — response body — data data gid, html text, resource type, title gid, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).title | string | Optional | The title of the project brief. |
$ (allOf 2).html_text | string | Optional | HTML formatted text for the project brief. See [rich text](/docs/rich-text). |
Referenced models: Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
Search projects in a workspace — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions. |
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 project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Known values: default_project, custom |
Get a project brief — response body — data data — sdk__Project Brief 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 *Project Brief* allows you to explain the what and why of the project to your team. |
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 |
title | string | Optional | The title of the project brief. |
html_text | string | Optional | HTML formatted text for the project brief. See [rich text](/docs/rich-text). |
text | string | Optional | [Opt In](/docs/inputoutput-options). The plain text of the project brief. |
permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
project | object | Optional | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions. The project with which this project brief is associated. |
project.gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
project.resource_type | string | Optional | The base type of this resource. Read only: true |
project.name | string | Optional | Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
project.resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Known values: default_project, custom |
Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *Project Brief* allows you to explain the what and why of the project to your team. |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.updateprojectbrief. Catalog operation: asana:updateProjectBrief. 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.