Asana API

Getting access, Developing, Testing

Back to Asana

Update A Project Brief

An existing project brief can be updated by making a PUT request on the URL for that project brief. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.

Returns the complete updated project brief record.

Input

type: object properties: parameters: type: object properties: project_brief_gid: type: string description: Globally unique identifier for the project brief. opt_pretty: type: boolean description: >- 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. opt_fields: type: array items: type: string description: >- Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options. required: - project_brief_gid title: Parameters data: type: object properties: data: type: object properties: gid: description: Globally unique identifier of the resource, as a string. type: string readOnly: true example: '12345' x-insert-after: false resource_type: description: The base type of this resource. type: string readOnly: true example: task x-insert-after: gid title: description: The title of the project brief. type: string example: Stuff to buy — Project Brief html_text: description: HTML formatted text for the project brief. type: string example: <body>This is a <strong>project brief</strong>.</body> text: description: >- The plain text of the project brief. When writing to a project brief, you can specify either `html_text` (preferred) or `text`, but not both. type: string example: This is a project brief. title: Data

Output

type: object properties: data: type: object properties: gid: description: Globally unique identifier of the resource, as a string. type: string readOnly: true example: '12345' x-insert-after: false resource_type: description: The base type of this resource. type: string readOnly: true example: task x-insert-after: gid title: description: The title of the project brief. type: string example: Stuff to buy — Project Brief html_text: description: HTML formatted text for the project brief. type: string example: <body>This is a <strong>project brief</strong>.</body> text: description: >- [Opt In](/docs/inputoutput-options). The plain text of the project brief. type: string example: This is a project brief. permalink_url: type: string readOnly: true description: A url that points directly to the object within Asana. example: https://app.asana.com/0/11111111/22222222 project: type: object properties: gid: description: Globally unique identifier of the resource, as a string. type: string readOnly: true example: '12345' x-insert-after: false resource_type: description: The base type of this resource. type: string readOnly: true example: task x-insert-after: gid 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 example: Stuff to buy