Create a story on a task

post https://app.asana.com/api/1.0/tasks/{task_gid}/stories

Adds a story to a task. This endpoint currently only allows for comment
stories to be created. The comment will be authored by the currently
authenticated user, and timestamped when the server receives the request.

Returns the full record for the new story added to the task.

Responses

Response body

object

data

object

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

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

created_at

date-time

The time at which this resource was created.

resource_subtype

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.

text

string

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

html_text

string

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

is_pinned

boolean

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

sticker_name

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

created_by

object

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

type

string

comment system

is_editable

boolean

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

is_edited

boolean

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

hearted

boolean

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

hearts

array of objects

Deprecated - please use likes instead

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

hearts

object

gid

string

Globally unique identifier of the object, as a string.

user

object

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

num_hearts

integer

Deprecated - please use likes instead

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

liked

boolean

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

likes

array of objects

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

likes

object

gid

string

Globally unique identifier of the object, as a string.

user

object

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

num_likes

integer

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

previews

array of objects

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

Note: This property only exists for comment stories.

previews

object

fallback

string

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

footer

string

Text to display in the footer.

header

string

Text to display in the header.

header_link

string

Where the header will link to.

html_text

string

HTML formatted text for the body of the preview.

text

string

Text for the body of the preview.

title

string

Text to display as the title.

title_link

string

Where to title will link to.

old_name

string

Conditional'

new_name

string | null

Conditional

old_dates

object

Conditional

new_dates

object

Conditional

old_resource_subtype

string

Conditional

new_resource_subtype

string

Conditional

story

object

Conditional

assignee

object

Conditional

follower

object

Conditional

old_section

object

Conditional

new_section

object

Conditional

task

object

Conditional

project

object

Conditional

tag

object

Conditional

custom_field

object

Conditional

old_text_value

string

Conditional

new_text_value

string

Conditional

old_number_value

integer | null

Conditional

new_number_value

integer

Conditional

old_enum_value

object

Conditional

new_enum_value

object

Conditional

old_date_value

object

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

new_date_value

object

Conditional The new value of a date custom field story.

old_people_value

array of objects

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

old_people_value

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

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

new_people_value

array of objects

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

new_people_value

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

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

old_multi_enum_values

array of objects

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

old_multi_enum_values

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

The name of the enum option.

enabled

boolean

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

color

string

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

new_multi_enum_values

array of objects

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

new_multi_enum_values

object

gid

string

Globally unique identifier of the resource, as a string.

resource_type

string

The base type of this resource.

name

string

The name of the enum option.

enabled

boolean

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

color

string

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

new_approval_status

string

Conditional. The new value of approval status.

old_approval_status

string

Conditional. The old value of approval status.

duplicate_of

object

Conditional

duplicated_from

object

Conditional

dependency

object

Conditional

source

string

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

web email mobile api unknown

target

object

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

Language

Credentials

Request


xxxxxxxxxx
1
curl --request POST \
2
     --url https://app.asana.com/api/1.0/tasks/task_gid/stories \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
267
}
1
{
2
  "data": {
3
    "gid": "12345",
4
    "resource_type": "story",
5
    "created_at": "2012-02-22T02:06:58.147Z",
6
    "resource_subtype": "comment_added",
7
    "text": "This is a comment.",
8
    "html_text": "<body>This is a comment.</body>",
9
    "is_pinned": false,
10
    "sticker_name": "dancing_unicorn",
11
    "created_by": {
12
      "gid": "12345",
13
      "resource_type": "user",
14
      "name": "Greg Sanchez"
15
    },
16
    "type": "comment",
17
    "is_editable": false,
18
    "is_edited": false,
19
    "hearted": false,
20
    "hearts": [
21
      {
22
        "gid": "12345",
23
        "user": {
24
          "gid": "12345",
25
          "resource_type": "user",

201Successfully created a new story.

400This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.

401A valid authentication token was not provided with the request, so the API could not associate a user with the request.

403The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.

404Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.

500There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.