Access requests4

Agents2

AI Studio usage API2

Allocations5

Attachments4

Audit log API1

Batch API1

Budgets5

Custom field settings4

Custom fields8

Custom types2

Events1

Exports2

Goal relationships5

Goals12

Jobs1

Memberships5

Ooo entries5

Organization exports2

Portfolio memberships3

Portfolios13

Project briefs4

Project memberships2

Project portfolio settings4

Project statuses4

Project templates5

Projects21

Rates5

Reactions1

Roles5

Rules1

Sections7

Status updates4

Stories7

Tags8

Task templates4

Tasks28

Team memberships4

Teams7

Time periods2

Time tracking categories6

Time tracking entries6

Timesheet approval statuses4

Typeahead1

User task lists2

Users8

Webhooks5

Workspace memberships3

Workspaces6

Custom fields

Update a custom field

Changed on May 21, 2026

<b>Required scope: </b><code>custom_fields:write</code>

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.

put/custom_fields/{custom_field_gid}

Request

Base URL: https://app.asana.com/api/1.0
URL: https://app.asana.com/api/1.0/custom_fields/{custom_field_gid}
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token, scopes: custom_fields:write)

Query parameters

opt_fieldsstring[]

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. Properties can include nested fields. To learn more, see the input/output options guide.

Request body

Example request

{
  "data": {
    "gid": "12345",
    "resource_type": "custom_field",
    "name": "Status",
    "enum_options": [
      {
        "gid": "12345",
        "resource_type": "enum_option",
        "name": "Low",
        "enabled": true,
        "color": "blue"
      }
    ],
    "enabled": true,
    "representation_type": "number",
    "id_prefix": "ID",
    "input_restrictions": [
      "task"
    ],
    "date_value": {
      "date": "2024-08-23",
      "date_time": "2024-08-23T22:00:00.000Z"
    },
    "enum_value": {
      "gid": "12345",
      "resource_type": "enum_option",
      "name": "Low",
      "enabled": true,
      "color": "blue"
    },
    "multi_enum_values": [
      {
        "gid": "12345",
        "resource_type": "enum_option",
        "name": "Low",
        "enabled": true,
        "color": "blue"
      }
    ],
    "number_value": 5.2,
    "text_value": "Some Value",
    "display_value": "blue",
    "description": "Development team priority",
    "precision": 2,
    "format": "custom",
    "currency_code": "EUR",
    "custom_label": "gold pieces",
    "custom_label_position": "suffix",
    "is_global_to_workspace": true,
    "has_notifications_enabled": true,
    "asana_created_field": "priority",
    "workspace": "1331",
    "people_value": [
      "12345"
    ],
    "reference_value": [
      "12345"
    ]
  }
}

Response

The custom field was successfully updated.

Example response

{
  "data": {
    "gid": "12345",
    "resource_type": "custom_field",
    "name": "Status",
    "enum_options": [
      {
        "gid": "12345",
        "resource_type": "enum_option",
        "name": "Low",
        "enabled": true,
        "color": "blue"
      }
    ],
    "enabled": true,
    "representation_type": "number",
    "id_prefix": "ID",
    "input_restrictions": [
      "task"
    ],
    "date_value": {
      "date": "2024-08-23",
      "date_time": "2024-08-23T22:00:00.000Z"
    },
    "enum_value": {
      "gid": "12345",
      "resource_type": "enum_option",
      "name": "Low",
      "enabled": true,
      "color": "blue"
    },
    "multi_enum_values": [
      {
        "gid": "12345",
        "resource_type": "enum_option",
        "name": "Low",
        "enabled": true,
        "color": "blue"
      }
    ],
    "number_value": 5.2,
    "text_value": "Some Value",
    "display_value": "blue",
    "description": "Development team priority",
    "precision": 2,
    "format": "custom",
    "currency_code": "EUR",
    "custom_label": "gold pieces",
    "custom_label_position": "suffix",
    "is_global_to_workspace": true,
    "has_notifications_enabled": true,
    "asana_created_field": "priority",
    "created_by": {
      "gid": "12345",
      "resource_type": "user",
      "name": "Greg Sanchez"
    },
    "people_value": [
      {
        "gid": "12345",
        "resource_type": "user",
        "name": "Greg Sanchez"
      }
    ],
    "reference_value": [
      {
        "gid": "12345",
        "resource_type": "task",
        "name": "Bug Task"
      }
    ],
    "html_text_value": "<body>Some Value</body>",
    "privacy_setting": "public_with_guests",
    "default_access_level": "user",
    "resource_subtype": "text"
  }
}

Changes

May 21, 2026b3dcd9ce0bf2 Revision changes
- breaking
  request property ////////// was restricted to a list of enum values
- warning
  added the new goal enum value to the ////////// response property for the response status
- warning
  added the new goal enum value to the /// response property for the response status
- warning
  added the new portfolio enum value to the ////////// response property for the response status
- warning
  added the new portfolio enum value to the /// response property for the response status
- warning
  added the new project enum value to the ////////// response property for the response status
- warning
  added the new project enum value to the /// response property for the response status
- warning
  added the new reference enum value to the ///////// response property for the response status
- warning
  added the new reference enum value to the ///////// response property for the response status
- warning
  added the new task enum value to the ////////// response property for the response status
- warning
  added the new task enum value to the /// response property for the response status
- info
  added the new goal enum value to the request property //////////
- info
  added the new portfolio enum value to the request property //////////
- info
  added the new project enum value to the request property //////////
- info
  added the new reference enum value to the request property /////////
- info
  added the new reference enum value to the request property /////////
- info
  added the new task enum value to the request property //////////
Apr 28, 2026b04e9dcf7c00 Revision changes
- info
  added the enum value html_text_value to the property items/ of the query request parameter opt_fields
- info
  added the optional property // to the response with the status

Operation history