Sample - Asana API
PUT/goals/{goal_gid}

Update a goal

Updates an existing goal and returns the complete updated goal record. Supply the fields to change in the data block; omitted fields remain unchanged, and use opt_fields to include optional response properties such as status updates or custom field settings.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
opt_fieldsarray<string>optional
Comma-separated response properties to include, including nested fields such as `current_status_update.title` and `custom_field_settings.custom_field.created_by.name`. Values must be selected from the documented optional properties.

The goal fields to update, wrapped in a data object; omitted fields remain unchanged.

dataobjectoptional
An object containing the goal properties to update, including supported fields such as `status` and `custom_fields`.

6 status codes
200Returns the complete updated goal record.
dataobjectoptional
400Returned when a parameter or request body is missing or malformed.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
403Returned when the authenticated user does not have access to the goal or requested properties.
errorsarray<object>optional
404Returned when the goal does not exist or the request does not identify a known action.
errorsarray<object>optional
500Returned when a server-side problem prevents the goal from being updated.
errorsarray<object>optional

Error handling

A 400 is returned when a parameter or request body is missing or malformed. A 401 is returned without valid authentication, and a 403 is returned when the authenticated user lacks access to the goal. A 404 indicates that the goal does not exist, while a 500 indicates a server-side failure; include only valid goal properties in data and opt_fields.