Remove users from a portfolio

Removes the specified list of users from members of the portfolio.
Returns the updated portfolio record.

Path Params
string
required

Globally unique identifier for the portfolio.

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

Information about the members being removed.

object
Responses

Response body
object
object

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 1500 items and, like projects, a max of 20 custom fields.

string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

The name of the portfolio.

boolean

Opt In. True if the portfolio is archived, false if not. Archived portfolios do not show in the UI by default and may be treated differently for queries.

string

Color of the portfolio.

dark-pink dark-green dark-blue dark-red dark-teal dark-brown dark-orange dark-purple dark-warm-gray light-pink light-green light-blue light-red light-teal light-brown light-orange light-purple light-warm-gray

date-time

The time at which this resource was created.

object

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

array of objects

Array of custom field settings applied to the portfolio.

custom_field_settings
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

object

Deprecated: new integrations should prefer the parent field. The id of the project that this custom field settings refers to.

boolean

is_important is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a project or portfolio.

object

The parent to which the custom field is applied. This can be a project or portfolio and indicates that the tasks or projects that the parent contains may be given custom field values for this custom field.

object

The custom field that is applied to the parent.

object | null

The latest status_update posted to this portfolio.

date | null

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

array of objects

Array of Custom Fields.

custom_fields
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

The name of the custom field.

string

Deprecated: new integrations should prefer the resource_subtype field. The type of the custom field. Must be one of the given values.

text enum multi_enum number date people

array of objects

Conditional. Only relevant for custom fields of type enum. This array specifies the possible values which an enum custom field can adopt. To modify the enum options, refer to working with enum options.

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

boolean

Conditional. Determines if the custom field is enabled or not.

string

This field tells the type of the custom field.

text enum multi_enum number date people formula custom_id

string | null

This field is the unique custom ID string for the custom field.

boolean

Conditional. This flag describes whether a custom field is a formula custom field.

object | null

Conditional. Only relevant for custom fields of type date. This object reflects the chosen date (and optionally, time) value of a date custom field. If no date is selected, the value of date_value will be null.

object | null

Conditional. Only relevant for custom fields of type enum. This object is the chosen value of an enum custom field.

array of objects

Conditional. Only relevant for custom fields of type multi_enum. This object is the chosen values of a multi_enum custom field.

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

number | null

Conditional. This number is the value of a number custom field.

string | null

Conditional. This string is the value of a text custom field.

string | null

A string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types.

array of objects
members
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.

object

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

date | null

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.

object

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

string
boolean

True if the portfolio is public to its workspace members.

string

The default access level when inviting new members to the portfolio

admin editor viewer

string

The privacy setting of the portfolio. Note: Administrators in your organization may restrict the values of privacy_setting.

public_to_domain members_only

array of objects

Array of project templates that are in the portfolio

project_templates
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

Name of the project template.

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.