{"command":{"effect":"write","timeoutSeconds":30,"inputSchema":{"type":"object","description":"<b>Required scope: </b><code>projects:write</code>\n\nA specific, existing project can be updated by making a PUT request on\nthe URL for that project. Only the fields provided in the `data` block\nwill be updated; any unspecified fields will remain unchanged.\n\nWhen using this method, it is best to specify only those fields you wish\nto change, or else you may overwrite changes made by another user since\nyou last retrieved the task.\n\nReturns the complete updated project record.\n\n**Deprecation notice:** Updating the `team` field is deprecated. When this\nfield is included in the request, the `Asana-Change` response header will\nindicate an affected deprecation. Clients should switch to using\n`POST /memberships` with `{ parent: project, member: team }` to share a\nproject with a team.","properties":{"path":{"type":"object","properties":{"project_gid":{"type":"string","examples":["1331"],"description":"Globally unique identifier for the project."}},"required":["project_gid"],"additionalProperties":false},"query":{"type":"object","properties":{"opt_pretty":{"type":"boolean","examples":[true],"description":"Provides “pretty” output.\nProvides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging."},"opt_fields":{"type":"array","items":{"type":"string","enum":["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"]},"examples":[["archived","color","completed","completed_at","completed_by","completed_by.name","created_at","created_from_template","created_from_template.name","current_status","current_status.author","current_status.author.name","current_status.color","current_status.created_at","current_status.created_by","current_status.created_by.name","current_status.html_text","current_status.modified_at","current_status.text","current_status.title","current_status_update","current_status_update.resource_subtype","current_status_update.title","custom_field_settings","custom_field_settings.custom_field","custom_field_settings.custom_field.asana_created_field","custom_field_settings.custom_field.created_by","custom_field_settings.custom_field.created_by.name","custom_field_settings.custom_field.currency_code","custom_field_settings.custom_field.custom_label","custom_field_settings.custom_field.custom_label_position","custom_field_settings.custom_field.date_value","custom_field_settings.custom_field.date_value.date","custom_field_settings.custom_field.date_value.date_time","custom_field_settings.custom_field.default_access_level","custom_field_settings.custom_field.description","custom_field_settings.custom_field.display_value","custom_field_settings.custom_field.enabled","custom_field_settings.custom_field.enum_options","custom_field_settings.custom_field.enum_options.color","custom_field_settings.custom_field.enum_options.enabled","custom_field_settings.custom_field.enum_options.name","custom_field_settings.custom_field.enum_value","custom_field_settings.custom_field.enum_value.color","custom_field_settings.custom_field.enum_value.enabled","custom_field_settings.custom_field.enum_value.name","custom_field_settings.custom_field.format","custom_field_settings.custom_field.has_notifications_enabled","custom_field_settings.custom_field.html_text_value","custom_field_settings.custom_field.id_prefix","custom_field_settings.custom_field.input_restrictions","custom_field_settings.custom_field.is_formula_field","custom_field_settings.custom_field.is_global_to_workspace","custom_field_settings.custom_field.is_lookup_field","custom_field_settings.custom_field.is_value_read_only","custom_field_settings.custom_field.multi_enum_values","custom_field_settings.custom_field.multi_enum_values.color","custom_field_settings.custom_field.multi_enum_values.enabled","custom_field_settings.custom_field.multi_enum_values.name","custom_field_settings.custom_field.name","custom_field_settings.custom_field.number_value","custom_field_settings.custom_field.people_value","custom_field_settings.custom_field.people_value.name","custom_field_settings.custom_field.precision","custom_field_settings.custom_field.privacy_setting","custom_field_settings.custom_field.reference_value","custom_field_settings.custom_field.reference_value.name","custom_field_settings.custom_field.representation_type","custom_field_settings.custom_field.resource_subtype","custom_field_settings.custom_field.text_value","custom_field_settings.custom_field.type","custom_field_settings.is_important","custom_field_settings.parent","custom_field_settings.parent.name","custom_field_settings.parent.resource_subtype","custom_field_settings.project","custom_field_settings.project.name","custom_field_settings.project.resource_subtype","custom_fields","custom_fields.date_value","custom_fields.date_value.date","custom_fields.date_value.date_time","custom_fields.display_value","custom_fields.enabled","custom_fields.enum_options","custom_fields.enum_options.color","custom_fields.enum_options.enabled","custom_fields.enum_options.name","custom_fields.enum_value","custom_fields.enum_value.color","custom_fields.enum_value.enabled","custom_fields.enum_value.name","custom_fields.id_prefix","custom_fields.input_restrictions","custom_fields.is_formula_field","custom_fields.is_lookup_field","custom_fields.multi_enum_values","custom_fields.multi_enum_values.color","custom_fields.multi_enum_values.enabled","custom_fields.multi_enum_values.name","custom_fields.name","custom_fields.number_value","custom_fields.representation_type","custom_fields.text_value","custom_fields.type","custom_type","custom_type.asana_created_type_identifier","custom_type.name","default_access_level","default_view","due_date","due_on","followers","followers.name","html_notes","icon","members","members.name","minimum_access_level_for_customization","minimum_access_level_for_sharing","modified_at","name","notes","owner","permalink_url","privacy_setting","project_brief","public","resource_subtype","start_on","team","team.name","workspace","workspace.name"]],"description":"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](/docs/inputoutput-options#selecting-nested-fields)."}},"required":[],"additionalProperties":false},"body":{"type":"object","properties":{"data":{"$ref":"#/definitions/ProjectUpdateRequest"}}}},"required":["path","body"],"additionalProperties":false,"definitions":{"ProjectUpdateRequest":{"allOf":[{"$ref":"#/definitions/ProjectBase"},{"type":"object","properties":{"custom_fields":{"description":"An object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, or object (depending on the custom field type). See the [custom fields guide](/docs/custom-fields-guide) for details on creating and updating custom field values.","type":"object","additionalProperties":{"type":"string","description":"\"{custom_field_gid}\" => Value (can be text, a number, etc.). For date, use format \"YYYY-MM-DD\" (e.g., 2019-09-15). For date-time, use ISO 8601 date string in UTC (e.g., 2019-09-15T02:06:58.147Z)."},"examples":[{"5678904321":"On Hold","4578152156":"Not Started"}]},"html_custom_fields":{"description":"An object where each key is the GID of a text custom field and the corresponding value is a rich text HTML string. Only text-type custom fields support this parameter. Values must be wrapped in <body></body> tags. See the [custom fields guide](/docs/custom-fields-guide) and [rich text](/docs/rich-text) for details on supported formatting.","type":"object","additionalProperties":{"type":"string","description":"\"{custom_field_gid}\" => HTML string (e.g., \"<body>Text content</body>\")"},"examples":[{"5678904321":"<body><strong>Bold text</strong></body>","4578152156":"<body><code>Code block</code></body>"}]},"followers":{"description":"*Create-only*. Comma separated string of users. Followers are a subset of members who have opted in to receive \"tasks added\" notifications for a project.","type":"string","examples":["12345,23456"]},"owner":{"description":"The current owner of the project, may be null.","type":["string","null"],"examples":["12345"]},"team":{"description":"*Deprecated:* Updating the team a project is shared with is deprecated. Use `POST /memberships` with `{ parent: project, member: team }` instead to manage team sharing.","type":"string","examples":["12345"]},"custom_type":{"type":["string","null"],"description":"*Conditional:* You can only set custom_type if project `resource_subtype` is `custom`. GID or globally-unique identifier of a project's custom type. The type must be valid for projects, and some Asana-created custom types cannot be assigned via the API; attempting either returns an error explaining which condition failed.","examples":["12345"]}}}]},"ProjectBase":{"allOf":[{"$ref":"#/definitions/ProjectCompact"},{"type":"object","properties":{"archived":{"description":"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.","type":"boolean","examples":[false]},"color":{"description":"Color of the project.","type":["string","null"],"enum":["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","none",null],"examples":["light-green"]},"icon":{"description":"The icon for a project.","type":["string","null"],"enum":["list","board","timeline","calendar","rocket","people","graph","star","bug","light_bulb","globe","gear","notebook","computer","check","target","html","megaphone","chat_bubbles","briefcase","page_layout","mountain_flag","puzzle","presentation","line_and_symbols","speed_dial","ribbon","shoe","shopping_basket","map","ticket","coins"],"examples":["chat_bubbles"]},"current_status":{"allOf":[{"$ref":"#/definitions/ProjectStatusResponse"},{"type":["object","null"],"description":"*Deprecated: new integrations should prefer the `current_status_update` resource.*"}]},"current_status_update":{"allOf":[{"$ref":"#/definitions/StatusUpdateCompact"},{"type":["object","null"],"description":"The latest `status_update` posted to this project."}]},"default_view":{"description":"The default view (list, board, calendar, or timeline) of a project.","type":"string","enum":["list","board","calendar","timeline"],"examples":["calendar"]},"due_date":{"description":"*Deprecated: new integrations should prefer the `due_on` field.*","type":["string","null"],"format":"date","examples":["2019-09-15"]},"due_on":{"description":"The day on which this project is due. This takes a date with format YYYY-MM-DD.","type":["string","null"],"format":"date","examples":["2019-09-15"]},"html_notes":{"description":"[Opt In](/docs/inputoutput-options). The notes of the project with formatting as HTML. See [rich text](/docs/rich-text).","type":"string","examples":["<body>These are things we need to purchase.</body>"]},"notes":{"description":"Free-form textual information associated with the project (ie., its description).","type":"string","examples":["These are things we need to purchase."]},"public":{"description":"*Deprecated:* new integrations use `privacy_setting` instead.","type":"boolean","examples":[false]},"privacy_setting":{"description":"The privacy setting of the project. *Note: Administrators in your organization may restrict the values of `privacy_setting`.* The value `private_to_team` is deprecated. Use `POST /memberships` to share a project with a team after creation.","type":"string","enum":["public_to_workspace","private_to_team","private"],"examples":["public_to_workspace"]},"start_on":{"description":"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.*","type":["string","null"],"format":"date","examples":["2019-09-14"]},"default_access_level":{"description":"The default access for users or teams who join or are added as members to the project.","type":"string","enum":["admin","editor","commenter","viewer"],"examples":["admin"]},"minimum_access_level_for_customization":{"description":"The minimum access level needed for project members to modify this project's workflow and appearance.","type":"string","enum":["admin","editor"],"examples":["admin"]},"minimum_access_level_for_sharing":{"description":"The minimum access level needed for project members to share the project and manage project memberships.","type":"string","enum":["admin","editor"],"examples":["admin"]}}}]},"ProjectCompact":{"description":"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.","type":"object","properties":{"name":{"description":"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.","type":"string","examples":["Stuff to buy"]},"resource_subtype":{"type":"string","description":"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.","enum":["default_project","custom"],"examples":["default_project"]}}},"ProjectStatusResponse":{"allOf":[{"$ref":"#/definitions/ProjectStatusBase"},{"type":"object","properties":{"author":{"$ref":"#/definitions/UserCompact"},"created_by":{"$ref":"#/definitions/UserCompact"}}}]},"StatusUpdateCompact":{"description":"A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object.","type":"object","properties":{"title":{"description":"The title of the status update.","type":"string","examples":["Status Update - Jun 15"]}}},"ProjectStatusBase":{"allOf":[{"$ref":"#/definitions/ProjectStatusCompact"},{"type":"object","properties":{"text":{"description":"The text content of the status update.","type":"string","examples":["The project is moving forward according to plan..."]},"html_text":{"description":"[Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. See [rich text](/docs/rich-text).","type":"string","examples":["<body>The project <strong>is</strong> moving forward according to plan...</body>"]},"color":{"description":"The color associated with the status update.","type":"string","enum":["green","yellow","red","blue","complete"]}}}]},"UserCompact":{"description":"A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.","type":"object","properties":{"name":{"type":"string","description":"*Read-only except when same user as requester*. The user's name.","examples":["Greg Sanchez"]}}},"ProjectStatusCompact":{"description":"*Deprecated: new integrations should prefer the `status_update` resource.*\nA *project status* is an update on the progress of a particular project, and is sent out to all project followers when created. These updates include both text describing the update and a color code intended to represent the overall state of the project: \"green\" for projects that are on track, \"yellow\" for projects at risk, and \"red\" for projects that are behind.","type":"object","properties":{"title":{"description":"The title of the project status update.","type":"string","examples":["Status Update - Jun 15"]}}}}},"name":"Update a project","id":"asana.updateproject","example":{"path":{"project_gid":"1331"},"body":{}},"maxRequests":1,"summary":false}}