Update a task

A specific, existing task can be updated by making a PUT request on the
URL for that task. 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 task record.

Path Params
string
required

The task to operate on.

Query Params
array of strings

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.

opt_fields
boolean

Provides “pretty” output.
Provides 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.

Body Params

The task to update.

object

The task is the basic object around which many operations in Asana are centered.

Responses

Response body
object
object

The task is the basic object around which many operations in Asana are centered.

string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

Name of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.

string

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.
The resource_subtype milestone represent a single moment in time. This means tasks with this subtype cannot have a start_date.

default_task milestone approval

object

Opt In. A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

string

Conditional Reflects the approval status of this task. This field is kept in sync with completed, meaning pending translates to false while approved, rejected, and changes_requested translate to true. If you set completed to true, this field will be set to approved.

pending approved rejected changes_requested

string

Deprecated Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. Setting this field to "inbox" or "upcoming" inserts it at the top of the section, while the other options will insert at the bottom.

today upcoming later new inbox

boolean

True if the task is currently marked complete, false if not.

date-time | null

The time at which this task was completed, or null if the task is incomplete.

object | null

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

date-time

The time at which this resource was created.

array of objects

Opt In. Array of resources referencing tasks that this task depends on. The objects contain only the gid of the dependency.

dependencies
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

array of objects

Opt In. Array of resources referencing tasks that depend on this task. The objects contain only the ID of the dependent.

dependents
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

date-time | null

The UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with due_on.

date | null

The localized date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with due_at.

object

OAuth Required. Conditional. This field is returned only if external values are set or included by using [Opt In] (/docs/inputoutput-options).
The external field allows you to store app-specific metadata on tasks, including a gid that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external gid is set, you can use the notation external:custom_gid to reference your object anywhere in the API where you may use the original object gid. See the page on Custom External Data for more details.

string

Opt In. The notes of the text with formatting as HTML.

boolean

Deprecated - please use liked instead True if the task is hearted by the authorized user, false if not.

array of objects

Deprecated - please use likes instead Array of likes for users who have hearted this task.

hearts
object
string

Globally unique identifier of the object, as a string.

object

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

boolean

Opt In. In some contexts tasks can be rendered as a visual separator; for instance, subtasks can appear similar to sections without being true section objects. If a task object is rendered this way in any context it will have the property is_rendered_as_separator set to true.

boolean

True if the task is liked by the authorized user, false if not.

array of objects

Array of likes for users who have liked this task.

likes
object
string

Globally unique identifier of the object, as a string.

object

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

array of objects

Create-only. Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the addProject and removeProject endpoints. Note that over time, more types of memberships may be added to this property.

memberships
object
object

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.

object

A section is a subdivision of a project that groups tasks together. It can either be a header above a list of tasks in a list view or a column in a board view of a project.

date-time

The time at which this task was last modified.

The following conditions will change modified_at:

  • story is created on a task
  • story is trashed on a task
  • attachment is trashed on a task
  • task is assigned or unassigned
  • custom field value is changed
  • the task itself is trashed
  • Or if any of the following fields are updated:
    • completed
    • name
    • due_date
    • description
    • attachments
    • items
    • schedule_status

The following conditions will not change modified_at:

  • moving to a new container (project, portfolio, etc)
  • comments being added to the task (but the stories they generate
    will affect modified_at)
string

Free-form textual information associated with the task (i.e. its description).

integer

Deprecated - please use likes instead The number of users who have hearted this task.

integer

The number of users who have liked this task.

integer

Opt In. The number of subtasks on this task.

date-time | null

Date and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with start_on.
Note: due_at must be present in the request when setting or unsetting the start_at parameter.

date | null

The day on which work begins for the task , or null if the task has no start date. This takes a date with YYYY-MM-DD format and should not be used together with start_at.
Note: due_on or due_at must be present in the request when setting or unsetting the start_on parameter.

number | null

This value represents the sum of all the Time Tracking entries in the Actual Time field on a given Task. It is represented as a nullable long value.

object | null

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

object | null

The assignee section is a subdivision of a project that groups tasks together in the assignee's "My Tasks" list. It can either be a header above a list of tasks in a list view or a column in a board view of "My Tasks."
The assignee_section property will be returned in the response only if the request was sent by the user who is the assignee of the task. Note that you can only write to assignee_section with the gid of an existing section visible in the user's "My Tasks" list.

array of objects

Array of custom field values applied to the task. These represent the custom field values recorded on this project for a particular custom field. For example, these custom field values will contain an enum_value property for custom fields of type enum, a text_value property for custom fields of type text, and so on. Please note that the gid returned on each custom field value is identical to the gid of the custom field, which allows referencing the custom field metadata through the /custom_fields/custom_field-gid endpoint.

custom_fields
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

The name of the custom field.

string

Deprecated: new integrations should prefer the resource_subtype field. The type of the custom field. Must be one of the given values.

text enum multi_enum number date people

array of objects

Conditional. Only relevant for custom fields of type 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.

enum_options
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

The name of the enum option.

boolean

Whether or not the enum option is a selectable value for the custom field.

string

The color of the enum option. Defaults to ‘none’.

boolean

Conditional. Determines if the custom field is enabled or not.

string

This field tells the type of the custom field.

text enum multi_enum number date people formula custom_id

string | null

This field is the unique custom ID string for the custom field.

boolean

Conditional. This flag describes whether a custom field is a formula custom field.

object | null

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.

object | null

Conditional. Only relevant for custom fields of type enum. This object is the chosen value of an enum custom field.

array of objects

Conditional. Only relevant for custom fields of type multi_enum. This object is the chosen values of a multi_enum custom field.

multi_enum_values
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

The name of the enum option.

boolean

Whether or not the enum option is a selectable value for the custom field.

string

The color of the enum option. Defaults to ‘none’.

number | null

Conditional. This number is the value of a number custom field.

string | null

Conditional. This string is the value of a text custom field.

string | null

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.

string

Opt In. The description of the custom field.

integer

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.
For 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%.
The identifier format will always have a precision of 0.

string

The format of this custom field.

currency identifier percentage custom duration none

string | null

ISO 4217 currency code to format this custom field. This will be null if the format is not currency.

string | null

This is the string that appears next to the custom field value. This will be null if the format is not custom.

string | null

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.

prefix suffix

boolean

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.

boolean

Conditional. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field.

string | null

Conditional. A unique identifier to associate this field with the template source of truth.

a_v_requirements account_name actionable align_shipping_link align_status allotted_time appointment approval_stage approved article_series board_committee browser campaign_audience campaign_project_status campaign_regions channel_primary client_topic_type complete_by contact contact_email_address content_channels content_channels_needed content_stage content_type contract contract_status cost creation_stage creative_channel creative_needed creative_needs data_sensitivity deal_size delivery_appt delivery_appt_date department department_responsible design_request_needed design_request_type discussion_category do_this_task editorial_content_status editorial_content_tag editorial_content_type effort effort_level est_completion_date estimated_time estimated_value expected_cost external_steps_needed favorite_idea feedback_type financial funding_amount grant_application_process hiring_candidate_status idea_status ids_link ids_patient_link implementation_stage insurance interview_area interview_question_score itero_scan_link job_s_applied_to lab launch_status lead_status localization_language localization_market_team localization_status meeting_minutes meeting_needed minutes mrr must_localize name_of_foundation need_to_follow_up next_appointment next_steps_sales num_people number_of_user_reports office_location onboarding_activity owner participants_needed patient_date_of_birth patient_email patient_phone patient_status phone_number planning_category point_of_contact position post_format prescription priority priority_level product product_stage progress project_size project_status proposed_budget publish_status reason_for_scan referral request_type research_status responsible_department responsible_team risk_assessment_status room_name sales_counterpart sentiment shipping_link social_channels stage status status_design status_of_initiative system_setup task_progress team team_marketing team_responsible time_it_takes_to_complete_tasks timeframe treatment_type type_work_requests_it use_agency user_name vendor_category vendor_type word_count

boolean

Conditional. This flag describes whether a custom field is read only.

object | null

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

array of objects

Conditional. Only relevant for custom fields of type people. This array of compact user objects reflects the values of a people custom field.

people_value
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

Read-only except when same user as requester. The user’s name.

string

The privacy setting of the custom field. Note: Administrators in your organization may restrict the values of privacy_setting.

public_with_guests public private

string

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.

admin editor user

string

The type of the custom field. Must be one of the given values.

text enum multi_enum number date people

object | null

Custom Types extend the types of Asana Objects, currently only Custom Tasks are supported.

object | null

A generic Asana Resource, containing a globally unique identifier.

array of objects

Array of users following this task.

followers
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

Read-only except when same user as requester. The user’s name.

object | null

The parent of this task, or null if this is not a subtask. This property cannot be modified using a PUT request but you can change it with the setParent endpoint. You can create subtasks by using the subtasks endpoint.

array of objects

Create-only. Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the addProject and removeProject endpoints.

projects
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

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.

array of objects

Array of tags associated with this task. In order to change tags on an existing task use addTag and removeTag.

tags
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.

object

Create-only. The workspace this task is associated with. Once created, task cannot be moved to a different workspace. This attribute can only be specified at creation time.

string

Language
Credentials
OAuth2
Request
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.