Upload an attachment

POST

/tasks/{task_gid}/attachments

Attachments

Upload an attachment.

This method uploads an attachment to a task and returns the compact
record for the created attachment object. It is not possible to attach
files from third party services such as Dropbox, Box & Google Drive via
the API. You must download the file content first and then upload it as
any other attachment.

The 100MB size limit on attachments in Asana is enforced on this endpoint.

This endpoint expects a multipart/form-data encoded request containing
the full contents of the file to be uploaded.

Requests made should follow the HTTP/1.1 specification that line
terminators are of the form CRLF or \r\n outlined
here
in order for the server to reliably and properly handle the request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.asana.com/api/1.0/tasks//attachments'

Response Example

200 - Example 1

{
    "data": {
        "gid": "12345",
        "resource_type": "task",
        "name": "Screenshot.png",
        "resource_subtype": null,
        "created_at": "2012-02-22T02:06:58.147Z",
        "download_url": "https://s3.amazonaws.com/assets/123/Screenshot.png",
        "host": "dropbox",
        "parent": {
            "gid": "12345",
            "resource_type": "task",
            "name": "Bug Task"
        },
        "view_url": "https://www.dropbox.com/s/123/Screenshot.png"
    }
}

Request

Path Params

task_gid

string

required

Body Params multipart/form-data

file

optional

Required for file attachments.

name

string

optional

The name of the external resource being attached. Required for attachments of type 'external'.

resource_subtype

string

optional

The type of the attachment. Must be one of the given values. If not specified, a file attachment of type asana_file_attachments will be assumed.

Example:

text

url

string

optional

The URL of the external resource being attached. Required for attachments of type 'external'.

Responses

🟢200Successfully uploaded the attachment to the task.

application/json

Body

data

object (AttachmentResponse)

optional

An attachment object represents any file attached to a task in Asana, whether it’s an uploaded file or one associated via a third-party service such as Dropbox or Google Drive.

created_at

string <date-time>

read-onlyoptional

The time at which this resource was created.

Example:

2012-02-22T02:06:58.147Z

download_url

string <uri> | null

read-onlyoptional

The URL containing the content of the attachment.
Note: May be null if the attachment is hosted by Box. If present, this URL may only be valid for two minutes from the time of retrieval. You should avoid persisting this URL somewhere and just refresh it on demand to ensure you do not keep stale URLs.

Example:

https://s3.amazonaws.com/assets/123/Screenshot.png

host

string

read-onlyoptional

The service hosting the attachment. Valid values are asana, dropbox, gdrive and box.

Example:

dropbox

parent

object

read-onlyoptional

The task this attachment is attached to.

view_url

string <uri> | null

read-onlyoptional

The URL where the attachment can be viewed, which may be friendlier to users in a browser than just directing them to a raw file. May be null if no view URL exists for the service.

Example:

https://www.dropbox.com/s/123/Screenshot.png

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

name

string

read-onlyoptional

The name of the file.

Example:

Screenshot.png

resource_subtype

optional

The service hosting the attachment. Valid values are asana, dropbox, gdrive, onedrive, box, and external.
external attachments are a beta feature currently limited to specific integrations.

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Modified at 2022-09-13 02:00:31

Get attachments for a task

Submit parallel requests