Update a custom field

PUT

/custom_fields/{custom_field_gid}

A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged
When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field.
A custom field’s type cannot be updated.
An enum custom field’s enum_options cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update enum_options.
Locked custom fields can only be updated by the user who locked the field.
Returns the complete updated custom field record.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://app.asana.com/api/1.0/custom_fields/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "enabled": true,
        "enum_options": [
            {
                "color": "blue",
                "enabled": true,
                "name": "Low"
            }
        ],
        "name": "Status",
        "number_value": 5.2,
        "resource_subtype": "text",
        "text_value": "Some Value",
        "currency_code": "EUR",
        "custom_label": "gold pieces",
        "custom_label_position": "suffix",
        "description": "Development team priority",
        "format": "custom",
        "has_notifications_enabled": true,
        "precision": 2,
        "workspace": "1331"
    }
}'

Response Example

200 - Example 1

{
    "data": {
        "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"
            }
        ]
    }
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200The custom field was successfully updated.

application/json

Body

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

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

Get a custom field

Create an enum option