Asana
  1. Projects
Asana
  • Attachments
    • Delete an attachment
      DELETE
    • Get an attachment
      GET
    • Get attachments for a task
      GET
    • Upload an attachment
      POST
  • Batch API
    • Submit parallel requests
      POST
  • Custom Fields
    • Create a custom field
      POST
    • Delete a custom field
      DELETE
    • Get a custom field
      GET
    • Update a custom field
      PUT
    • Create an enum option
      POST
    • Reorder a custom field's enum
      POST
    • Update an enum option
      PUT
    • Get a workspace's custom fields
      GET
  • Events
    • Get events on a resource
  • Goals
    • Get goals
    • Create a goal
    • Delete a goal
    • Get a goal
    • Update a goal
    • Add a collaborator to a goal
    • Add a subgoal to a parent goal
    • Add a project/portfolio as supporting work for a goal.
    • Get parent goals from a goal
    • Remove a collaborator from a goal
    • Remove a subgoal from a goal
    • Remove a project/portfolio as supporting work for a goal.
    • Create a goal metric
    • Update a goal metric
    • Get subgoals from a goal
    • Get supporting work from a goal
  • Jobs
    • Get a job by id
  • Organization Exports
    • Create an organization export request
    • Get details on an org export request
  • Teams
    • Get teams in an organization
    • Create a team
    • Get a team
    • Add a user to a team
    • Remove a user from a team
    • Get teams for a user
  • Portfolio Memberships
    • Get multiple portfolio memberships
    • Get a portfolio membership
    • Get memberships from a portfolio
  • Portfolios
    • Get multiple portfolios
    • Create a portfolio
    • Delete a portfolio
    • Get a portfolio
    • Update a portfolio
    • Add a custom field to a portfolio
    • Add a portfolio item
    • Add users to a portfolio
    • Get portfolio items
    • Remove a custom field from a portfolio
    • Remove a portfolio item
    • Remove users from a portfolio
  • Custom Field Settings
    • Get a portfolio's custom fields
    • Get a project's custom fields
  • Project Memberships
    • Get a project membership
    • Get memberships from a project
  • Project Statuses
    • Delete a project status
    • Get a project status
    • Get statuses from a project
    • Create a project status
  • Projects
    • Get multiple projects
      GET
    • Create a project
      POST
    • Delete a project
      DELETE
    • Get a project
      GET
    • Update a project
      PUT
    • Add a custom field to a project
      POST
    • Add followers to a project
      POST
    • Add users to a project
      POST
    • Duplicate a project
      POST
    • Remove a custom field from a project
      POST
    • Remove followers from a project
      POST
    • Remove users from a project
      POST
    • Get task count of a project
      GET
    • Get projects a task is in
      GET
    • Get a team's projects
      GET
    • Create a project in a team
      POST
    • Get all projects in a workspace
      GET
    • Create a project in a workspace
      POST
  • Sections
    • Get sections in a project
    • Create a section in a project
    • Move or Insert sections
    • Delete a section
    • Get a section
    • Update a section
    • Add task to section
  • Tasks
    • Get tasks from a project
    • Get tasks from a section
    • Get tasks from a tag
    • Get multiple tasks
    • Create a task
    • Delete a task
    • Get a task
    • Update a task
    • Set dependencies for a task
    • Set dependents for a task
    • Add followers to a task
    • Add a project to a task
    • Add a tag to a task
    • Get dependencies from a task
    • Get dependents from a task
    • Duplicate a task
    • Unlink dependencies from a task
    • Unlink dependents from a task
    • Remove followers from a task
    • Remove a project from a task
    • Remove a tag from a task
    • Set the parent of a task
    • Get subtasks from a task
    • Create a subtask
    • Get tasks from a user task list
    • Search tasks in a workspace
  • Stories
    • Delete a story
    • Get a story
    • Update a story
    • Get stories from a task
    • Create a story on a task
  • Tags
    • Get multiple tags
    • Create a tag
    • Delete a tag
    • Get a tag
    • Update a tag
    • Get a task's tags
    • Get tags in a workspace
    • Create a tag in a workspace
  • Team Memberships
    • Get team memberships
    • Get a team membership
    • Get memberships from a team
    • Get memberships from a user
  • Users
    • Get users in a team
    • Get multiple users
    • Get a user
    • Get a user's favorites
    • Get users in a workspace or organization
  • Time Periods
    • Get time periods
    • Get a time period
  • User Task Lists
    • Get a user task list
    • Get a user's task list
  • Workspace Memberships
    • Get workspace memberships for a user
    • Get a workspace membership
    • Get the workspace memberships for a workspace
  • Webhooks
    • Get multiple webhooks
    • Establish a webhook
    • Delete a webhook
    • Get a webhook
  • Workspaces
    • Get multiple workspaces
    • Get a workspace
    • Update a workspace
    • Add a user to a workspace or organization
    • Remove a user from a workspace or organization
  • Typeahead
    • Get objects via typeahead
  1. Projects

Update a project

PUT
/projects/{project_gid}
Projects
A specific, existing project can be updated by making a PUT request on
the URL for that project. 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 task.
Returns the complete updated project record.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://app.asana.com/api/1.0/projects/' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
200 - Example 1
{
  "data": {
    "gid": "12345",
    "resource_type": "task",
    "name": "Stuff to buy",
    "archived": false,
    "color": "light-green",
    "created_at": "2012-02-22T02:06:58.147Z",
    "current_status": {
      "gid": "12345",
      "resource_type": "task",
      "title": "Status Update - Jun 15",
      "color": "green",
      "html_text": "<body>The project <strong>is</strong> moving forward according to plan...</body>",
      "text": "The project is moving forward according to plan...",
      "author": {
        "gid": "12345",
        "resource_type": "task",
        "name": "Greg Sanchez"
      },
      "created_at": "2012-02-22T02:06:58.147Z",
      "created_by": {
        "gid": "12345",
        "resource_type": "task",
        "name": "Greg Sanchez"
      },
      "modified_at": "2012-02-22T02:06:58.147Z"
    },
    "custom_field_settings": [
      {
        "gid": "12345",
        "resource_type": "task"
      }
    ],
    "default_view": "calendar",
    "due_date": "2019-09-15",
    "due_on": "2019-09-15",
    "html_notes": "<body>These are things we need to purchase.</body>",
    "is_template": false,
    "members": [
      {
        "gid": "12345",
        "resource_type": "task",
        "name": "Greg Sanchez"
      }
    ],
    "modified_at": "2012-02-22T02:06:58.147Z",
    "notes": "These are things we need to purchase.",
    "public": false,
    "start_on": "2019-09-14",
    "workspace": {
      "gid": "12345",
      "resource_type": "task",
      "name": "My Company Workspace"
    },
    "custom_fields": [
      {
        "gid": "12345",
        "resource_type": "task",
        "display_value": "blue",
        "enabled": true,
        "enum_options": [
          {
            "gid": "12345",
            "resource_type": "task",
            "color": "blue",
            "enabled": true,
            "name": "Low"
          }
        ],
        "name": "Status",
        "number_value": 5.2,
        "resource_subtype": "text",
        "text_value": "Some Value",
        "type": "text"
      }
    ],
    "followers": [
      {
        "gid": "12345",
        "resource_type": "task",
        "name": "Greg Sanchez"
      }
    ],
    "icon": "chat_bubbles",
    "owner": {
      "gid": "12345",
      "resource_type": "task",
      "name": "Greg Sanchez"
    },
    "permalink_url": "https://app.asana.com/0/resource/123456789/list",
    "team": {
      "gid": "12345",
      "resource_type": "task",
      "name": "Marketing"
    }
  }
}

Request

Path Params
project_gid
string 
required
Body Params application/json
data
object (ProjectRequest) 
optional
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.
custom_fields
object 
optional
An object where each key is a Custom Field gid and each value is an enum gid, string, or number.
Example:
{"4578152156":"Not Started","5678904321":"On Hold"}
followers
string 
optional
Create-only. Comma separated string of users. Followers are a subset of members who receive all notifications for a project, the default notification setting when adding members to a project in-product.
Example:
12345,23456
owner
string  | null 
optional
The current owner of the project, may be null.
Example:
12345
team
string 
optional
Create-only. The team that this project is shared with. This field only exists for projects in organizations.
Example:
12345
archived
boolean 
optional
True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries.
Example:
false
color
enum<string>  | enum<null> 
optional
Color of the project.
Allowed values:
dark-pinkdark-greendark-bluedark-reddark-tealdark-browndark-orangedark-purpledark-warm-graylight-pinklight-greenlight-bluelight-redlight-teallight-brownlight-orangelight-purplelight-warm-gray
Example:
light-green
current_status
null  | allOf {1} 
optional
default_view
enum<string> 
optional
The default view (list, board, calendar, or timeline) of a project.
Allowed values:
listboardcalendartimeline
Example:
calendar
due_date
string <date-time> | null 
optional
Deprecated: new integrations should prefer the due_on field.
Example:
2019-09-15
due_on
string <date-time> | null 
optional
The day on which this project is due. This takes a date with format YYYY-MM-DD.
Example:
2019-09-15
html_notes
string 
optional
Opt In. The notes of the project with formatting as HTML.
Example:
<body>These are things we need to purchase.</body>
is_template
boolean 
optional
Opt In. Determines if the project is a template.
Example:
false
notes
string 
optional
Free-form textual information associated with the project (ie., its description).
Example:
These are things we need to purchase.
public
boolean 
optional
True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access.
Example:
false
start_on
string <date> | null 
optional
The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format. Note: due_on or due_at must be present in the request when setting or unsetting the start_on parameter. Additionally, start_on and due_on cannot be the same date.
Example:
2019-09-14
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.
Example:
Stuff to buy
Examples

Responses

🟢200Successfully updated the project.
application/json
Body
data
object (ProjectResponse) 
optional
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.
custom_fields
array[object (CustomFieldCompact) {10}] 
read-onlyoptional
Array of Custom Fields.
followers
array[object (UserCompact) {3}] 
read-onlyoptional
Array of users following this project. Followers are a subset of members who receive all notifications for a project, the default notification setting when adding members to a project in-product.
icon
enum<string>  | enum<null> 
optional
The icon for a project.
Allowed values:
listboardtimelinecalendarrocketpeoplegraphstarbuglight_bulbglobegearnotebookcomputerchecktargethtmlmegaphonechat_bubblesbriefcasepage_layoutmountain_flagpuzzlepresentationline_and_symbolsspeed_dialribbonshoeshopping_basketmapticketcoins
Example:
chat_bubbles
owner
null  | allOf {1} 
optional
The current owner of the project, may be null.
permalink_url
string 
read-onlyoptional
A url that points directly to the object within Asana.
Example:
https://app.asana.com/0/resource/123456789/list
team
object 
optional
Create-only. The team that this project is shared with. This field only exists for projects in organizations.
archived
boolean 
optional
True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries.
Example:
false
color
enum<string>  | enum<null> 
optional
Color of the project.
Allowed values:
dark-pinkdark-greendark-bluedark-reddark-tealdark-browndark-orangedark-purpledark-warm-graylight-pinklight-greenlight-bluelight-redlight-teallight-brownlight-orangelight-purplelight-warm-gray
Example:
light-green
created_at
string <date-time>
read-onlyoptional
The time at which this resource was created.
Example:
2012-02-22T02:06:58.147Z
current_status
null  | allOf {1} 
optional
custom_field_settings
array[object (CustomFieldSettingCompact) {2}] 
read-onlyoptional
Array of Custom Field Settings (in compact form).
default_view
enum<string> 
optional
The default view (list, board, calendar, or timeline) of a project.
Allowed values:
listboardcalendartimeline
Example:
calendar
due_date
string <date-time> | null 
optional
Deprecated: new integrations should prefer the due_on field.
Example:
2019-09-15
due_on
string <date-time> | null 
optional
The day on which this project is due. This takes a date with format YYYY-MM-DD.
Example:
2019-09-15
html_notes
string 
optional
Opt In. The notes of the project with formatting as HTML.
Example:
<body>These are things we need to purchase.</body>
is_template
boolean 
optional
Opt In. Determines if the project is a template.
Example:
false
members
array[object (UserCompact) {3}] 
read-onlyoptional
Array of users who are members of this project.
modified_at
string <date-time>
read-onlyoptional
The time at which this project was last modified.
Note: This does not currently reflect any changes in associations such as tasks or comments that may have been added or removed from the project.
Example:
2012-02-22T02:06:58.147Z
notes
string 
optional
Free-form textual information associated with the project (ie., its description).
Example:
These are things we need to purchase.
public
boolean 
optional
True if the project is public to the organization. If false, do not share this project with other users in this organization without explicitly checking to see if they have access.
Example:
false
start_on
string <date> | null 
optional
The day on which work for this project begins, or null if the project has no start date. This takes a date with YYYY-MM-DD format. Note: due_on or due_at must be present in the request when setting or unsetting the start_on parameter. Additionally, start_on and due_on cannot be the same date.
Example:
2019-09-14
workspace
object 
read-onlyoptional
Create-only. The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time.
gid
string 
read-onlyoptional
Globally unique identifier of the resource, as a string.
Example:
12345
resource_type
string 
read-onlyoptional
The base type of this resource.
Example:
task
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.
Example:
Stuff to buy
🟠400400
🟠401401
🟠403403
🟠404404
🔴500500
Modified at 2022-09-13 02:00:31
Previous
Get a project
Next
Add a custom field to a project
Built with