{
"name": "UpdateProjectDetails",
"fully_qualified_name": "AsanaApi.UpdateProjectDetails@0.1.0",
"description": "Update specific fields of an existing project.\n\nUse this tool to update specific fields of an existing project in Asana. Specify only the fields you wish to change to avoid overwriting changes made by others. Returns the fully updated project record.",
"toolkit": {
"name": "AsanaApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "project_global_id",
"required": true,
"description": "Globally unique identifier for the project to be updated.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Globally unique identifier for the project."
},
"inferrable": true,
"http_endpoint_parameter_name": "project_gid"
},
{
"name": "updated_project_fields",
"required": true,
"description": "The JSON object containing specific fields to update within the project. Only include fields you want to change to avoid overwriting others' changes.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"data": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"inner_properties": null,
"description": "The updated fields for the project."
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
},
{
"name": "include_optional_properties",
"required": false,
"description": "Comma-separated list of properties to include in the response, showing optional fields by default excluded.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"inferrable": true,
"http_endpoint_parameter_name": "opt_fields"
},
{
"name": "enable_pretty_output",
"required": false,
"description": "Enable pretty formatting for the response output, making it more readable with line breaks and indentation. Use this primarily for debugging as it increases response size and processing time.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Provides \u201cpretty\u201d output.\nProvides the response in a \u201cpretty\u201d 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."
},
"inferrable": true,
"http_endpoint_parameter_name": "opt_pretty"
}
]
},
"output": {
"description": "Response from the API endpoint 'updateProject'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": {
"provider_id": "arcade-asana",
"provider_type": "oauth2",
"id": null,
"oauth2": {
"scopes": [
"projects:write"
]
}
},
"secrets": null,
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.1.0",
"description": "Tools that enable LLMs to interact directly with the asana API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://app.asana.com/api/1.0/projects/{project_gid}",
"http_method": "PUT",
"headers": {},
"parameters": [
{
"name": "opt_pretty",
"tool_parameter_name": "enable_pretty_output",
"description": "Provides \u201cpretty\u201d output.\nProvides the response in a \u201cpretty\u201d 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.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Provides \u201cpretty\u201d output.\nProvides the response in a \u201cpretty\u201d 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."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "opt_fields",
"tool_parameter_name": "include_optional_properties",
"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.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"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."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "project_gid",
"tool_parameter_name": "project_global_id",
"description": "Globally unique identifier for the project.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Globally unique identifier for the project."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "requestBody",
"tool_parameter_name": "updated_project_fields",
"description": "The updated fields for the project.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"data": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"inner_properties": null,
"description": "The updated fields for the project."
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
],
"request_body_spec": "{\n \"description\": \"The updated fields for the project.\",\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"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.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"project\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"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.\",\n \"type\": \"string\",\n \"example\": \"Stuff to buy\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"archived\": {\n \"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.\",\n \"type\": \"boolean\",\n \"example\": false\n },\n \"color\": {\n \"description\": \"Color of the project.\",\n \"type\": \"string\",\n \"nullable\": true,\n \"enum\": [\n \"dark-pink\",\n \"dark-green\",\n \"dark-blue\",\n \"dark-red\",\n \"dark-teal\",\n \"dark-brown\",\n \"dark-orange\",\n \"dark-purple\",\n \"dark-warm-gray\",\n \"light-pink\",\n \"light-green\",\n \"light-blue\",\n \"light-red\",\n \"light-teal\",\n \"light-brown\",\n \"light-orange\",\n \"light-purple\",\n \"light-warm-gray\",\n \"none\",\n null\n ],\n \"example\": \"light-green\"\n },\n \"created_at\": {\n \"description\": \"The time at which this resource was created.\",\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2012-02-22T02:06:58.147Z\"\n },\n \"current_status\": {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"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.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"project_status\",\n \"x-insert-after\": \"gid\"\n },\n \"title\": {\n \"description\": \"The title of the project status update.\",\n \"type\": \"string\",\n \"example\": \"Status Update - Jun 15\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"text\": {\n \"description\": \"The text content of the status update.\",\n \"type\": \"string\",\n \"example\": \"The project is moving forward according to plan...\"\n },\n \"html_text\": {\n \"description\": \"[Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML.\",\n \"type\": \"string\",\n \"example\": \"The project is moving forward according to plan...\"\n },\n \"color\": {\n \"description\": \"The color associated with the status update.\",\n \"type\": \"string\",\n \"enum\": [\n \"green\",\n \"yellow\",\n \"red\",\n \"blue\",\n \"complete\"\n ]\n }\n }\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"author\": {\n \"description\": \"A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"user\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"*Read-only except when same user as requester*. The user's name.\",\n \"example\": \"Greg Sanchez\"\n }\n }\n },\n \"created_at\": {\n \"description\": \"The time at which this resource was created.\",\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2012-02-22T02:06:58.147Z\"\n },\n \"created_by\": {\n \"description\": \"A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"user\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"*Read-only except when same user as requester*. The user's name.\",\n \"example\": \"Greg Sanchez\"\n }\n }\n },\n \"modified_at\": {\n \"description\": \"The time at which this project status was last modified.\\n*Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the project status.*\",\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2012-02-22T02:06:58.147Z\"\n }\n }\n }\n ]\n },\n {\n \"type\": \"object\",\n \"nullable\": true,\n \"description\": \"*Deprecated: new integrations should prefer the `current_status_update` resource.*\"\n }\n ]\n },\n \"current_status_update\": {\n \"allOf\": [\n {\n \"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 project.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"status_update\",\n \"x-insert-after\": \"gid\"\n },\n \"title\": {\n \"description\": \"The title of the status update.\",\n \"type\": \"string\",\n \"example\": \"Status Update - Jun 15\"\n },\n \"resource_subtype\": {\n \"type\": \"string\",\n \"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.\\nThe `resource_subtype`s for `status` objects represent the type of their parent.\",\n \"enum\": [\n \"project_status_update\",\n \"portfolio_status_update\",\n \"goal_status_update\"\n ],\n \"example\": \"project_status_update\",\n \"readOnly\": true\n }\n }\n },\n {\n \"type\": \"object\",\n \"nullable\": true,\n \"description\": \"The latest `status_update` posted to this project.\"\n }\n ]\n },\n \"custom_field_settings\": {\n \"description\": \"
Full object requires scope: custom_fields:read
\\n\\nArray of Custom Field Settings (in compact form).\",\n \"readOnly\": true,\n \"type\": \"array\",\n \"items\": {\n \"allOf\": [\n {\n \"description\": \"Custom Fields Settings objects represent the many-to-many join of the Custom Field and Project as well as stores information that is relevant to that particular pairing.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"custom_field_setting\",\n \"x-insert-after\": \"gid\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"project\": {\n \"allOf\": [\n {\n \"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.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"project\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"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.\",\n \"type\": \"string\",\n \"example\": \"Stuff to buy\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"description\": \"*Deprecated: new integrations should prefer the `parent` field.* The id of the project that this custom field settings refers to.\",\n \"readOnly\": true\n }\n ]\n },\n \"is_important\": {\n \"description\": \"`is_important` is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a project or portfolio.\",\n \"type\": \"boolean\",\n \"readOnly\": true,\n \"example\": false\n },\n \"parent\": {\n \"allOf\": [\n {\n \"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.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"project\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"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.\",\n \"type\": \"string\",\n \"example\": \"Stuff to buy\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"description\": \"The parent to which the custom field is applied. This can be a project or portfolio and indicates that the tasks or projects that the parent contains may be given custom field values for this custom field.\",\n \"readOnly\": true\n }\n ]\n },\n \"custom_field\": {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"allOf\": [\n {\n \"description\": \"Custom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.\\n\\nUsers in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"custom_field\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"description\": \"The name of the custom field.\",\n \"type\": \"string\",\n \"example\": \"Status\"\n },\n \"type\": {\n \"description\": \"*Deprecated: new integrations should prefer the resource_subtype field.* The type of the custom field. Must be one of the given values.\\n\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"enum\": [\n \"text\",\n \"enum\",\n \"multi_enum\",\n \"number\",\n \"date\",\n \"people\"\n ]\n },\n \"enum_options\": {\n \"description\": \"*Conditional*. Only relevant for custom fields of type `enum` or `multi_enum`. This array specifies the possible values which an `enum` custom field can adopt. To modify the enum options, refer to [working with enum options](/reference/createenumoptionforcustomfield).\",\n \"type\": \"array\",\n \"items\": {\n \"description\": \"Enum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 500.\\n\\nYou can add enum options to a custom field by using the `POST /custom_fields/custom_field_gid/enum_options` endpoint.\\n\\n**It is not possible to remove or delete an enum option**. Instead, enum options can be disabled by updating the `enabled` field to false with the `PUT /enum_options/enum_option_gid` endpoint. Other attributes can be updated similarly.\\n\\nOn creation of an enum option, `enabled` is always set to `true`, meaning the enum option is a selectable value for the custom field. Setting `enabled=false` is equivalent to \\u201ctrashing\\u201d the enum option in the Asana web app within the \\u201cEdit Fields\\u201d dialog. The enum option will no longer be selectable but, if the enum option value was previously set within a task, the task will retain the value.\\n\\nEnum options are an ordered list and by default new enum options are inserted at the end. Ordering in relation to existing enum options can be specified on creation by using `insert_before` or `insert_after` to reference an existing enum option. Only one of `insert_before` and `insert_after` can be provided when creating a new enum option.\\n\\nAn enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` endpoint.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"enum_option\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"description\": \"The name of the enum option.\",\n \"type\": \"string\",\n \"example\": \"Low\"\n },\n \"enabled\": {\n \"description\": \"Whether or not the enum option is a selectable value for the custom field.\",\n \"type\": \"boolean\",\n \"example\": true\n },\n \"color\": {\n \"description\": \"The color of the enum option. Defaults to `none`.\",\n \"type\": \"string\",\n \"example\": \"blue\"\n }\n }\n }\n },\n \"enabled\": {\n \"description\": \"*Conditional*. This field applies only to [custom field values](/docs/custom-fields-guide#/accessing-custom-field-values-on-tasks-or-projects) and is not available for [custom field definitions](/docs/custom-fields-guide#/accessing-custom-field-definitions).\\nDetermines if the custom field is enabled or not. For more details, see the [Custom Fields documentation](/docs/custom-fields-guide#/enabled-and-disabled-values).\",\n \"type\": \"boolean\",\n \"readOnly\": true,\n \"example\": true\n },\n \"representation_type\": {\n \"description\": \"This field tells the type of the custom field.\",\n \"type\": \"string\",\n \"example\": \"number\",\n \"readOnly\": true,\n \"enum\": [\n \"text\",\n \"enum\",\n \"multi_enum\",\n \"number\",\n \"date\",\n \"people\",\n \"formula\",\n \"custom_id\"\n ]\n },\n \"id_prefix\": {\n \"description\": \"This field is the unique custom ID string for the custom field.\",\n \"type\": \"string\",\n \"nullable\": true,\n \"example\": \"ID\"\n },\n \"input_restrictions\": {\n \"description\": \"*Conditional*. Only relevant for custom fields of type `reference`. This array of strings reflects the allowed types of objects that can be written to a `reference` custom field value.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"example\": \"task\"\n },\n \"is_formula_field\": {\n \"description\": \"*Conditional*. This flag describes whether a custom field is a formula custom field.\",\n \"type\": \"boolean\",\n \"example\": false\n },\n \"date_value\": {\n \"description\": \"*Conditional*. Only relevant for custom fields of type `date`. This object reflects the chosen date (and optionally, time) value of a `date` custom field. If no date is selected, the value of `date_value` will be `null`.\",\n \"type\": \"object\",\n \"nullable\": true,\n \"properties\": {\n \"date\": {\n \"type\": \"string\",\n \"description\": \"A string representing the date in YYYY-MM-DD format.\",\n \"example\": \"2024-08-23\"\n },\n \"date_time\": {\n \"type\": \"string\",\n \"description\": \"A string representing the date in ISO 8601 format. If no time value is selected, the value of `date-time` will be `null`.\",\n \"example\": \"2024-08-23T22:00:00.000Z\"\n }\n }\n },\n \"enum_value\": {\n \"allOf\": [\n {\n \"description\": \"Enum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 500.\\n\\nYou can add enum options to a custom field by using the `POST /custom_fields/custom_field_gid/enum_options` endpoint.\\n\\n**It is not possible to remove or delete an enum option**. Instead, enum options can be disabled by updating the `enabled` field to false with the `PUT /enum_options/enum_option_gid` endpoint. Other attributes can be updated similarly.\\n\\nOn creation of an enum option, `enabled` is always set to `true`, meaning the enum option is a selectable value for the custom field. Setting `enabled=false` is equivalent to \\u201ctrashing\\u201d the enum option in the Asana web app within the \\u201cEdit Fields\\u201d dialog. The enum option will no longer be selectable but, if the enum option value was previously set within a task, the task will retain the value.\\n\\nEnum options are an ordered list and by default new enum options are inserted at the end. Ordering in relation to existing enum options can be specified on creation by using `insert_before` or `insert_after` to reference an existing enum option. Only one of `insert_before` and `insert_after` can be provided when creating a new enum option.\\n\\nAn enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` endpoint.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"enum_option\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"description\": \"The name of the enum option.\",\n \"type\": \"string\",\n \"example\": \"Low\"\n },\n \"enabled\": {\n \"description\": \"Whether or not the enum option is a selectable value for the custom field.\",\n \"type\": \"boolean\",\n \"example\": true\n },\n \"color\": {\n \"description\": \"The color of the enum option. Defaults to `none`.\",\n \"type\": \"string\",\n \"example\": \"blue\"\n }\n }\n },\n {\n \"type\": \"object\",\n \"nullable\": true,\n \"description\": \"*Conditional*. Only relevant for custom fields of type `enum`. This object is the chosen value of an `enum` custom field.\"\n }\n ]\n },\n \"multi_enum_values\": {\n \"description\": \"*Conditional*. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.\",\n \"type\": \"array\",\n \"items\": {\n \"description\": \"Enum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 500.\\n\\nYou can add enum options to a custom field by using the `POST /custom_fields/custom_field_gid/enum_options` endpoint.\\n\\n**It is not possible to remove or delete an enum option**. Instead, enum options can be disabled by updating the `enabled` field to false with the `PUT /enum_options/enum_option_gid` endpoint. Other attributes can be updated similarly.\\n\\nOn creation of an enum option, `enabled` is always set to `true`, meaning the enum option is a selectable value for the custom field. Setting `enabled=false` is equivalent to \\u201ctrashing\\u201d the enum option in the Asana web app within the \\u201cEdit Fields\\u201d dialog. The enum option will no longer be selectable but, if the enum option value was previously set within a task, the task will retain the value.\\n\\nEnum options are an ordered list and by default new enum options are inserted at the end. Ordering in relation to existing enum options can be specified on creation by using `insert_before` or `insert_after` to reference an existing enum option. Only one of `insert_before` and `insert_after` can be provided when creating a new enum option.\\n\\nAn enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` endpoint.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"enum_option\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"description\": \"The name of the enum option.\",\n \"type\": \"string\",\n \"example\": \"Low\"\n },\n \"enabled\": {\n \"description\": \"Whether or not the enum option is a selectable value for the custom field.\",\n \"type\": \"boolean\",\n \"example\": true\n },\n \"color\": {\n \"description\": \"The color of the enum option. Defaults to `none`.\",\n \"type\": \"string\",\n \"example\": \"blue\"\n }\n }\n }\n },\n \"number_value\": {\n \"description\": \"*Conditional*. This number is the value of a `number` custom field.\",\n \"type\": \"number\",\n \"nullable\": true,\n \"example\": 5.2\n },\n \"text_value\": {\n \"description\": \"*Conditional*. This string is the value of a `text` custom field.\",\n \"type\": \"string\",\n \"nullable\": true,\n \"example\": \"Some Value\"\n },\n \"display_value\": {\n \"description\": \"A string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"blue\",\n \"nullable\": true\n }\n }\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"description\": \"[Opt In](/docs/inputoutput-options). The description of the custom field.\",\n \"type\": \"string\",\n \"example\": \"Development team priority\"\n },\n \"enum_options\": {\n \"description\": \"*Conditional*. Only relevant for custom fields of type `enum` or `multi_enum`. This array specifies the possible values which an `enum` custom field can adopt. To modify the enum options, refer to [working with enum options](/reference/createenumoptionforcustomfield).\",\n \"type\": \"array\",\n \"items\": {\n \"description\": \"Enum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 500.\\n\\nYou can add enum options to a custom field by using the `POST /custom_fields/custom_field_gid/enum_options` endpoint.\\n\\n**It is not possible to remove or delete an enum option**. Instead, enum options can be disabled by updating the `enabled` field to false with the `PUT /enum_options/enum_option_gid` endpoint. Other attributes can be updated similarly.\\n\\nOn creation of an enum option, `enabled` is always set to `true`, meaning the enum option is a selectable value for the custom field. Setting `enabled=false` is equivalent to \\u201ctrashing\\u201d the enum option in the Asana web app within the \\u201cEdit Fields\\u201d dialog. The enum option will no longer be selectable but, if the enum option value was previously set within a task, the task will retain the value.\\n\\nEnum options are an ordered list and by default new enum options are inserted at the end. Ordering in relation to existing enum options can be specified on creation by using `insert_before` or `insert_after` to reference an existing enum option. Only one of `insert_before` and `insert_after` can be provided when creating a new enum option.\\n\\nAn enum options list can be reordered with the `POST /custom_fields/custom_field_gid/enum_options/insert` endpoint.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"enum_option\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"description\": \"The name of the enum option.\",\n \"type\": \"string\",\n \"example\": \"Low\"\n },\n \"enabled\": {\n \"description\": \"Whether or not the enum option is a selectable value for the custom field.\",\n \"type\": \"boolean\",\n \"example\": true\n },\n \"color\": {\n \"description\": \"The color of the enum option. Defaults to `none`.\",\n \"type\": \"string\",\n \"example\": \"blue\"\n }\n }\n }\n },\n \"precision\": {\n \"description\": \"Only relevant for custom fields of type `Number`. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive.\\nFor percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%.\\nThe identifier format will always have a precision of 0.\",\n \"type\": \"integer\",\n \"example\": 2\n },\n \"format\": {\n \"description\": \"The format of this custom field.\",\n \"type\": \"string\",\n \"enum\": [\n \"currency\",\n \"identifier\",\n \"percentage\",\n \"custom\",\n \"duration\",\n \"none\"\n ],\n \"example\": \"custom\"\n },\n \"currency_code\": {\n \"description\": \"ISO 4217 currency code to format this custom field. This will be null if the `format` is not `currency`.\",\n \"type\": \"string\",\n \"nullable\": true,\n \"example\": \"EUR\"\n },\n \"custom_label\": {\n \"description\": \"This is the string that appears next to the custom field value. This will be null if the `format` is not `custom`.\",\n \"type\": \"string\",\n \"nullable\": true,\n \"example\": \"gold pieces\"\n },\n \"custom_label_position\": {\n \"description\": \"Only relevant for custom fields with `custom` format. This depicts where to place the custom label. This will be null if the `format` is not `custom`.\",\n \"type\": \"string\",\n \"nullable\": true,\n \"enum\": [\n \"prefix\",\n \"suffix\",\n null\n ],\n \"example\": \"suffix\"\n },\n \"is_global_to_workspace\": {\n \"description\": \"This flag describes whether this custom field is available to every container in the workspace. Before project-specific custom fields, this field was always true.\",\n \"type\": \"boolean\",\n \"example\": true,\n \"readOnly\": true\n },\n \"has_notifications_enabled\": {\n \"description\": \"*Conditional*. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field.\",\n \"type\": \"boolean\",\n \"example\": true\n },\n \"asana_created_field\": {\n \"description\": \"*Conditional*. A unique identifier to associate this field with the template source of truth.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"nullable\": true,\n \"enum\": [\n \"a_v_requirements\",\n \"account_name\",\n \"actionable\",\n \"align_shipping_link\",\n \"align_status\",\n \"allotted_time\",\n \"appointment\",\n \"approval_stage\",\n \"approved\",\n \"article_series\",\n \"board_committee\",\n \"browser\",\n \"campaign_audience\",\n \"campaign_project_status\",\n \"campaign_regions\",\n \"channel_primary\",\n \"client_topic_type\",\n \"complete_by\",\n \"contact\",\n \"contact_email_address\",\n \"content_channels\",\n \"content_channels_needed\",\n \"content_stage\",\n \"content_type\",\n \"contract\",\n \"contract_status\",\n \"cost\",\n \"creation_stage\",\n \"creative_channel\",\n \"creative_needed\",\n \"creative_needs\",\n \"data_sensitivity\",\n \"deal_size\",\n \"delivery_appt\",\n \"delivery_appt_date\",\n \"department\",\n \"department_responsible\",\n \"design_request_needed\",\n \"design_request_type\",\n \"discussion_category\",\n \"do_this_task\",\n \"editorial_content_status\",\n \"editorial_content_tag\",\n \"editorial_content_type\",\n \"effort\",\n \"effort_level\",\n \"est_completion_date\",\n \"estimated_time\",\n \"estimated_value\",\n \"expected_cost\",\n \"external_steps_needed\",\n \"favorite_idea\",\n \"feedback_type\",\n \"financial\",\n \"funding_amount\",\n \"grant_application_process\",\n \"hiring_candidate_status\",\n \"idea_status\",\n \"ids_link\",\n \"ids_patient_link\",\n \"implementation_stage\",\n \"insurance\",\n \"interview_area\",\n \"interview_question_score\",\n \"itero_scan_link\",\n \"job_s_applied_to\",\n \"lab\",\n \"launch_status\",\n \"lead_status\",\n \"localization_language\",\n \"localization_market_team\",\n \"localization_status\",\n \"meeting_minutes\",\n \"meeting_needed\",\n \"minutes\",\n \"mrr\",\n \"must_localize\",\n \"name_of_foundation\",\n \"need_to_follow_up\",\n \"next_appointment\",\n \"next_steps_sales\",\n \"num_people\",\n \"number_of_user_reports\",\n \"office_location\",\n \"onboarding_activity\",\n \"owner\",\n \"participants_needed\",\n \"patient_date_of_birth\",\n \"patient_email\",\n \"patient_phone\",\n \"patient_status\",\n \"phone_number\",\n \"planning_category\",\n \"point_of_contact\",\n \"position\",\n \"post_format\",\n \"prescription\",\n \"priority\",\n \"priority_level\",\n \"product\",\n \"product_stage\",\n \"progress\",\n \"project_size\",\n \"project_status\",\n \"proposed_budget\",\n \"publish_status\",\n \"reason_for_scan\",\n \"referral\",\n \"request_type\",\n \"research_status\",\n \"responsible_department\",\n \"responsible_team\",\n \"risk_assessment_status\",\n \"room_name\",\n \"sales_counterpart\",\n \"sentiment\",\n \"shipping_link\",\n \"social_channels\",\n \"stage\",\n \"status\",\n \"status_design\",\n \"status_of_initiative\",\n \"system_setup\",\n \"task_progress\",\n \"team\",\n \"team_marketing\",\n \"team_responsible\",\n \"time_it_takes_to_complete_tasks\",\n \"timeframe\",\n \"treatment_type\",\n \"type_work_requests_it\",\n \"use_agency\",\n \"user_name\",\n \"vendor_category\",\n \"vendor_type\",\n \"word_count\",\n null\n ],\n \"example\": \"priority\"\n }\n }\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"representation_type\": {\n \"description\": \"This field tells the type of the custom field.\",\n \"type\": \"string\",\n \"example\": \"number\",\n \"readOnly\": true,\n \"enum\": [\n \"text\",\n \"enum\",\n \"multi_enum\",\n \"number\",\n \"date\",\n \"people\",\n \"formula\",\n \"custom_id\",\n \"reference\"\n ]\n },\n \"id_prefix\": {\n \"description\": \"This field is the unique custom ID string for the custom field.\",\n \"type\": \"string\",\n \"nullable\": true,\n \"example\": \"ID\"\n },\n \"input_restrictions\": {\n \"description\": \"*Conditional*. Only relevant for custom fields of type `reference`. This array of strings reflects the allowed types of objects that can be written to a `reference` custom field value.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"example\": \"task\"\n },\n \"is_formula_field\": {\n \"description\": \"*Conditional*. This flag describes whether a custom field is a formula custom field.\",\n \"type\": \"boolean\",\n \"example\": false\n },\n \"is_value_read_only\": {\n \"description\": \"*Conditional*. This flag describes whether a custom field is read only.\",\n \"type\": \"boolean\",\n \"example\": false\n },\n \"created_by\": {\n \"allOf\": [\n {\n \"description\": \"A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"user\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"*Read-only except when same user as requester*. The user's name.\",\n \"example\": \"Greg Sanchez\"\n }\n }\n },\n {\n \"nullable\": true\n }\n ]\n },\n \"people_value\": {\n \"description\": \"*Conditional*. Only relevant for custom fields of type `people`. This array of [compact user](/reference/users) objects reflects the values of a `people` custom field.\",\n \"type\": \"array\",\n \"items\": {\n \"description\": \"A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"user\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"*Read-only except when same user as requester*. The user's name.\",\n \"example\": \"Greg Sanchez\"\n }\n }\n }\n },\n \"reference_value\": {\n \"description\": \"*Conditional*. Only relevant for custom fields of type `reference`. This array of objects reflects the values of a `reference` custom field.\",\n \"type\": \"array\",\n \"items\": {\n \"description\": \"A generic Asana Resource, containing a globally unique identifier.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"task\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"description\": \"The name of the object.\",\n \"type\": \"string\",\n \"example\": \"Bug Task\"\n }\n }\n }\n },\n \"privacy_setting\": {\n \"description\": \"The privacy setting of the custom field. *Note: Administrators in your organization may restrict the values of `privacy_setting`.*\",\n \"type\": \"string\",\n \"enum\": [\n \"public_with_guests\",\n \"public\",\n \"private\"\n ],\n \"example\": \"public_with_guests\"\n },\n \"default_access_level\": {\n \"description\": \"The default access level when inviting new members to the custom field. This isn't applied when the `privacy_setting` is `private`, or the user is a guest. For local fields in a project or portfolio, the user must additionally have permission to modify the container itself.\",\n \"type\": \"string\",\n \"enum\": [\n \"admin\",\n \"editor\",\n \"user\"\n ],\n \"example\": \"user\"\n },\n \"resource_subtype\": {\n \"description\": \"The type of the custom field. Must be one of the given values.\\n\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"text\",\n \"enum\": [\n \"text\",\n \"enum\",\n \"multi_enum\",\n \"number\",\n \"date\",\n \"people\",\n \"reference\"\n ]\n }\n }\n }\n ]\n },\n {\n \"type\": \"object\",\n \"description\": \"The custom field that is applied to the `parent`.\",\n \"readOnly\": true\n }\n ]\n }\n }\n }\n ]\n }\n },\n \"default_view\": {\n \"description\": \"The default view (list, board, calendar, or timeline) of a project.\",\n \"type\": \"string\",\n \"enum\": [\n \"list\",\n \"board\",\n \"calendar\",\n \"timeline\"\n ],\n \"example\": \"calendar\"\n },\n \"due_date\": {\n \"description\": \"*Deprecated: new integrations should prefer the `due_on` field.*\",\n \"type\": \"string\",\n \"nullable\": true,\n \"format\": \"date\",\n \"example\": \"2019-09-15\"\n },\n \"due_on\": {\n \"description\": \"The day on which this project is due. This takes a date with format YYYY-MM-DD.\",\n \"type\": \"string\",\n \"nullable\": true,\n \"format\": \"date\",\n \"example\": \"2019-09-15\"\n },\n \"html_notes\": {\n \"description\": \"[Opt In](/docs/inputoutput-options). The notes of the project with formatting as HTML.\",\n \"type\": \"string\",\n \"example\": \"These are things we need to purchase.\"\n },\n \"members\": {\n \"description\": \"Array of users who are members of this project.\",\n \"type\": \"array\",\n \"items\": {\n \"description\": \"A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.\",\n \"type\": \"object\",\n \"properties\": {\n \"gid\": {\n \"description\": \"Globally unique identifier of the resource, as a string.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"12345\",\n \"x-insert-after\": false\n },\n \"resource_type\": {\n \"description\": \"The base type of this resource.\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"example\": \"user\",\n \"x-insert-after\": \"gid\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"*Read-only except when same user as requester*. The user's name.\",\n \"example\": \"Greg Sanchez\"\n }\n }\n },\n \"readOnly\": true\n },\n \"modified_at\": {\n \"description\": \"The time at which this project was last modified.\\n*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.*\",\n \"type\": \"string\",\n \"readOnly\": true,\n \"format\": \"date-time\",\n \"example\": \"2012-02-22T02:06:58.147Z\"\n },\n \"notes\": {\n \"description\": \"Free-form textual information associated with the project (ie., its description).\",\n \"type\": \"string\",\n \"example\": \"These are things we need to purchase.\"\n },\n \"public\": {\n \"description\": \"*Deprecated:* new integrations use `privacy_setting` instead.\",\n \"type\": \"boolean\",\n \"deprecated\": true,\n \"example\": false\n },\n \"privacy_setting\": {\n \"description\": \"The privacy setting of the project. *Note: Administrators in your organization may restrict the values of `privacy_setting`.*\",\n \"type\": \"string\",\n \"enum\": [\n \"public_to_workspace\",\n \"private_to_team\",\n \"private\"\n ],\n \"example\": \"public_to_workspace\"\n },\n \"start_on\": {\n \"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.*\",\n \"type\": \"string\",\n \"nullable\": true,\n \"format\": \"date\",\n \"example\": \"2019-09-14\"\n },\n \"default_access_level\": {\n \"description\": \"The default access for users or teams who join or are added as members to the project.\",\n \"type\": \"string\",\n \"enum\": [\n \"admin\",\n \"editor\",\n \"commenter\",\n \"viewer\"\n ],\n \"example\": \"admin\"\n },\n \"minimum_access_level_for_customization\": {\n \"description\": \"The minimum access level needed for project members to modify this project's workflow and appearance.\",\n \"type\": \"string\",\n \"enum\": [\n \"admin\",\n \"editor\"\n ],\n \"example\": \"admin\"\n },\n \"minimum_access_level_for_sharing\": {\n \"description\": \"The minimum access level needed for project members to share the project and manage project memberships.\",\n \"type\": \"string\",\n \"enum\": [\n \"admin\",\n \"editor\"\n ],\n \"example\": \"admin\"\n }\n }\n }\n ]\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"custom_fields\": {\n \"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.\",\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"string\",\n \"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).\"\n },\n \"example\": {\n \"5678904321\": \"On Hold\",\n \"4578152156\": \"Not Started\"\n }\n },\n \"followers\": {\n \"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.\",\n \"type\": \"string\",\n \"example\": \"12345,23456\"\n },\n \"owner\": {\n \"description\": \"The current owner of the project, may be null.\",\n \"nullable\": true,\n \"type\": \"string\",\n \"example\": \"12345\"\n },\n \"team\": {\n \"description\": \"The team that this project is shared with.\",\n \"type\": \"string\",\n \"example\": \"12345\"\n }\n }\n }\n ]\n }\n }\n }\n }\n }\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}