Create a story on a task

post

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

Required scope: stories:write

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.

Omit parent_comment to create a top-level comment. To create a threaded
reply, pass the top-level comment's comment_gid, not its story gid.
Retrieve it with GET /stories/{story_gid}?opt_fields=comment_gid or
GET /tasks/{task_gid}/stories?opt_fields=comment_gid,text,anchor_gid.
The parent must belong to this task and must not itself be a reply.
A top-level comment's anchor_gid is the task GID; a reply's anchor_gid
is its parent comment's envelope GID.

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

Path Params

task_gid

string

required

The task to operate on.

Query Params

opt_fields

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. Properties can include nested fields. To learn more, see the input/output options guide.

opt_fields

opt_pretty

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 story to create.

data

object

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

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.