Update a story

Updates the story and returns the full record for the updated story. Only comment stories can have their text updated, and only comment stories and attachment stories can be pinned. Only one of text and html_text can be specified.

Path Params
string
required

Globally unique identifier for the story.

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 comment story to update.

object

A story represents an activity associated with an object in the Asana system.

Responses

Response body
object
object

A story represents an activity associated with an object in the Asana system.

string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

date-time

The time at which this resource was created.

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.

string

The plain text of the comment to add. Cannot be used with html_text.

string

Opt In. HTML formatted text for a comment. This will not include the name of the creator.

boolean

Conditional. Whether the story should be pinned on the resource.

string

The name of the sticker in this story. null if there is no sticker.

green_checkmark people_dancing dancing_unicorn heart party_popper people_waving_flags splashing_narwhal trophy yeti_riding_unicorn celebrating_people determined_climbers phoenix_spreading_love

object

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

string

comment system

boolean

Conditional. Whether the text of the story can be edited after creation.

boolean

Conditional. Whether the text of the story has been edited after creation.

boolean

Deprecated - please use likes instead
Conditional. True if the story is hearted by the authorized user, false if not.

array of objects

Deprecated - please use likes instead

Conditional. Array of likes for users who have hearted this story.

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.

integer

Deprecated - please use likes instead

Conditional. The number of users who have hearted this story.

boolean

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

array of objects

Conditional. Array of likes for users who have liked this story.

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.

integer

Conditional. The number of users who have liked this story.

array of objects

Conditional. A collection of previews to be displayed in the story.

Note: This property only exists for comment stories.

previews
object
string

Some fallback text to display if unable to display the full preview.

string
string

Text to display in the header.

string
string

HTML formatted text for the body of the preview.

string

Text for the body of the preview.

string

Text to display as the title.

string
string

Conditional'

string | null

Conditional

object

Conditional

object

Conditional

string

Conditional

string

Conditional

object

Conditional

object

Conditional

object

Conditional

object

Conditional

object

Conditional

object

Conditional

object

Conditional

object

Conditional

object

Conditional

string

Conditional

string

Conditional

integer | null

Conditional

integer

Conditional

object

Conditional

object

Conditional

object

Conditional. The old value of a date custom field story.

object

Conditional The new value of a date custom field story.

array of objects

Conditional. The old value of a people custom field story.

old_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.

array of objects

Conditional. The new value of a people custom field story.

new_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.

array of objects

Conditional. The old value of a multi-enum custom field story.

old_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’.

array of objects

Conditional. The new value of a multi-enum custom field story.

new_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’.

string

Conditional. The new value of approval status.

string

Conditional. The old value of approval status.

object

Conditional

object

Conditional

object

Conditional

string

The component of the Asana product the user used to trigger the story.

web email mobile api unknown

object

The object this story is associated with. Currently may only be a task.

Language
Credentials
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.