Create a portfolio

POST

/portfolios

Portfolios

Creates a new portfolio in the given workspace with the supplied name.

Note that portfolios created in the Asana UI may have some state
(like the “Priority” custom field) which is automatically added
to the portfolio when it is created. Portfolios created via our
API will not be created with the same initial state to allow
integrations to create their own starting state on a portfolio.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.asana.com/api/1.0/portfolios' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "name": "Bug Portfolio",
        "color": "light-green",
        "members": [
            "52164",
            "15363"
        ],
        "workspace": "167589"
    }
}'

Response Example

201 - Example 1

{
    "data": {
        "gid": "12345",
        "resource_type": "task",
        "name": "Bug Portfolio",
        "color": "light-green",
        "created_at": "2012-02-22T02:06:58.147Z",
        "created_by": {
            "gid": "12345",
            "resource_type": "task",
            "name": "Greg Sanchez"
        },
        "custom_field_settings": [
            {
                "gid": "12345",
                "resource_type": "task",
                "custom_field": {
                    "gid": "12345",
                    "resource_type": "task",
                    "display_value": "blue",
                    "enabled": true,
                    "enum_options": [
                        {
                            "gid": "12345",
                            "resource_type": "task",
                            "color": "blue",
                            "enabled": true,
                            "name": "Low"
                        }
                    ],
                    "name": "Status",
                    "number_value": 5.2,
                    "resource_subtype": "text",
                    "text_value": "Some Value",
                    "type": "text",
                    "currency_code": "EUR",
                    "custom_label": "gold pieces",
                    "custom_label_position": "suffix",
                    "description": "Development team priority",
                    "format": "custom",
                    "has_notifications_enabled": true,
                    "is_global_to_workspace": true,
                    "precision": 2,
                    "created_by": {
                        "gid": "12345",
                        "resource_type": "task",
                        "name": "Greg Sanchez"
                    },
                    "enum_value": {
                        "gid": "12345",
                        "resource_type": "task",
                        "color": "blue",
                        "enabled": true,
                        "name": "Low"
                    },
                    "multi_enum_values": [
                        {
                            "gid": "12345",
                            "resource_type": "task",
                            "color": "blue",
                            "enabled": true,
                            "name": "Low"
                        }
                    ]
                },
                "is_important": false,
                "parent": {
                    "gid": "12345",
                    "resource_type": "task",
                    "name": "Stuff to buy"
                },
                "project": {
                    "gid": "12345",
                    "resource_type": "task",
                    "name": "Stuff to buy"
                }
            }
        ],
        "due_on": "2019-09-15",
        "members": [
            {
                "gid": "12345",
                "resource_type": "task",
                "name": "Greg Sanchez"
            }
        ],
        "owner": {
            "gid": "12345",
            "resource_type": "task",
            "name": "Greg Sanchez"
        },
        "permalink_url": "https://app.asana.com/0/resource/123456789/list",
        "start_on": "2019-09-14",
        "workspace": {
            "gid": "12345",
            "resource_type": "task",
            "name": "My Company Workspace"
        }
    }
}

Request

Body Params application/json

data

object (PortfolioRequest)

optional

A portfolio gives a high-level overview of the status of multiple initiatives in Asana. Portfolios provide a dashboard overview of the state of multiple projects, including a progress report and the most recent project status update.
Portfolios have some restrictions on size. Each portfolio has a max of 250 items and, like projects, a max of 20 custom fields.

members

array[string]

optional

An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.

Example:

["52164","15363"]

workspace

string

optional

Gid of an object.

Example:

167589

color

enum<string>

optional

Color of the portfolio.

Allowed values:

dark-pinkdark-greendark-bluedark-reddark-tealdark-browndark-orangedark-purpledark-warm-graylight-pinklight-greenlight-bluelight-redlight-teallight-brownlight-orangelight-purplelight-warm-gray

Example:

light-green

name

string

optional

The name of the portfolio.

Example:

Bug Portfolio

Examples

Responses

🟢201Successfully created portfolio.

application/json

Body

data

object (PortfolioResponse)

optional

created_at

string <date-time>

read-onlyoptional

The time at which this resource was created.

Example:

2012-02-22T02:06:58.147Z

created_by

object

UserCompact

optional

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

custom_field_settings

array[object (CustomFieldSettingResponse) {6}]

optional

Array of custom field settings applied to the portfolio.

due_on

string <date-time> | null

optional

The localized day on which this portfolio is due. This takes a date with format YYYY-MM-DD.

Example:

2019-09-15

members

array[object (UserCompact) {3}]

read-onlyoptional

owner

object

UserCompact

optional

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

permalink_url

string

read-onlyoptional

A url that points directly to the object within Asana.

Example:

https://app.asana.com/0/resource/123456789/list

start_on

string <date> | null

optional

The day on which work for this portfolio begins, or null if the portfolio has no start date. This takes a date with YYYY-MM-DD format. Note: due_on must be present in the request when setting or unsetting the start_on parameter. Additionally, start_on and due_on cannot be the same date.

Example:

2019-09-14

workspace

object

optional

Create-only. The workspace or organization that the portfolio belongs to.

color

enum<string>

optional

Color of the portfolio.

Allowed values:

dark-pinkdark-greendark-bluedark-reddark-tealdark-browndark-orangedark-purpledark-warm-graylight-pinklight-greenlight-bluelight-redlight-teallight-brownlight-orangelight-purplelight-warm-gray

Example:

light-green

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

optional

The name of the portfolio.

Example:

Bug Portfolio

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

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

Get multiple portfolios

Delete a portfolio