Update an enum option

PUT

/enum_options/{enum_option_gid}

Updates an existing enum option. Enum custom fields require at least one enabled enum option.
Locked custom fields can only be updated by the user who locked the field.
Returns the full record of the updated enum option.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://app.asana.com/api/1.0/enum_options/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "color": "blue",
        "enabled": true,
        "name": "Low",
        "insert_after": "12345",
        "insert_before": "12345"
    }
}'

Response Example

200 - Example 1

{
    "data": {
        "gid": "12345",
        "resource_type": "task",
        "color": "blue",
        "enabled": true,
        "name": "Low"
    }
}

Request

Path Params

enum_option_gid

string

required

Body Params application/json

data

object (EnumOptionRequest)

optional

Enum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 50.

You can add enum options to a custom field by using the POST /custom_fields/custom_field_gid/enum_options endpoint.

It is not possible to remove or delete an enum option. Instead, enum options can be disabled by updating the enabled field to false with the PUT /enum_options/enum_option_gid endpoint. Other attributes can be updated similarly.

On creation of an enum option, enabled is always set to true, meaning the enum option is a selectable value for the custom field. Setting enabled=false is equivalent to “trashing” the enum option in the Asana web app within the “Edit Fields” dialog. The enum option will no longer be selectable but, if the enum option value was previously set within a task, the task will retain the value.

Enum options are an ordered list and by default new enum options are inserted at the end. Ordering in relation to existing enum options can be specified on creation by using insert_before or insert_after to reference an existing enum option. Only one of insert_before and insert_after can be provided when creating a new enum option.

An enum options list can be reordered with the POST /custom_fields/custom_field_gid/enum_options/insert endpoint.

insert_after

string

optional

An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.

Example:

12345

insert_before

string

optional

An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.

Example:

12345

color

string

optional

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

Example:

blue

enabled

boolean

optional

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

Example:

true

name

string

optional

The name of the enum option.

Example:

Low

Examples

Responses

🟢200Successfully updated the specified custom field enum.

application/json

Body

data

object (EnumOption)

optional

Enum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 50.

You can add enum options to a custom field by using the POST /custom_fields/custom_field_gid/enum_options endpoint.

An enum options list can be reordered with the POST /custom_fields/custom_field_gid/enum_options/insert endpoint.

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

color

string

optional

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

Example:

blue

enabled

boolean

optional

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

Example:

true

name

string

optional

The name of the enum option.

Example:

Low

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

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

Reorder a custom field's enum

Get a workspace's custom fields