Create a custom field

POST

/custom_fields

Creates a new custom field in a workspace. Every custom field is required
to be created in a specific workspace, and this workspace cannot be
changed once set.

A custom field’s name must be unique within a workspace and not conflict
with names of existing task properties such as ‘Due Date’ or ‘Assignee’.
A custom field’s type must be one of ‘text’, ‘enum’, or ‘number’.

Returns the full record of the newly created custom field.

Request

Body Params application/json

Examples

Responses

🟢201Custom field successfully created.

application/json

Body

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '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

201 - 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"
            }
        ]
    }
}

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

Submit parallel requests

Delete a custom field