Sample - Asana API
PUT/project_briefs/{project_brief_gid}

Update a project brief

Updates an existing project brief using only the fields supplied in the data block. Omitted fields remain unchanged, so you can update the brief text without replacing the complete record. Use opt_fields to select additional properties in the returned project brief.

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

1 parameter · 1 body field
opt_fieldsarray<string>optional
A comma-separated selection of project brief properties to include in the response, including `html_text`, `permalink_url`, `project`, `project.name`, `text`, or `title`. Omit it to use the default response fields.

Updated project brief fields wrapped in a data object. Only fields supplied in data are changed; omitted fields remain unchanged.

dataobjectoptional

6 status codes
200Returns the complete updated project brief record in the `data` object, including any properties selected through `opt_fields`.
dataobjectoptional
400Returned when the request body or `opt_fields` selection is 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 project brief.
errorsarray<object>optional
404Returned when the project brief does not exist, or the method and path do not identify a known action.
errorsarray<object>optional
500Returned when the API encounters a server-side failure.
errorsarray<object>optional

Error handling

A 400 is returned when the request body or opt_fields selection is malformed. A 401 indicates that no valid authentication token was provided, while a 403 indicates that the authenticated user lacks access to the project brief. A 404 indicates that the project brief does not exist, and a 500 indicates a server-side failure.