Sample - Asana API
PUT/custom_fields/{custom_field_gid}

Update a custom field

Updates an existing custom field while preserving any properties you omit from the request. Supply only the properties you want to change, because the custom field's type and an enum custom field's enum_options cannot be updated here. The authenticated user must have the custom_fields:write scope, and locked custom fields can only be updated by the user who locked them.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
opt_fieldsarray<string>optional
A comma-separated list of optional properties to include in the response, including nested properties. Supported values include `asana_created_field`, `created_by`, `created_by.name`, `currency_code`, `custom_label`, `custom_label_position`, `date_value`, `date_value.date`, `date_value.date_time`, `default_access_level`, `description`, and `display_value`, among others.

The custom field properties to update; only properties included in the data object are changed.

dataobjectoptional

6 status codes
200Returns the complete updated custom field record.
dataobjectoptional
400Returned when a parameter or request value is missing or malformed.
errorsarray<object>optional
401Returned when a valid authentication token was not provided with the request.
errorsarray<object>optional
403Returned when the authenticated user does not have access to the custom field or the requested operation.
errorsarray<object>optional
404Returned when the request does not identify a known action or the specified custom field does not exist.
errorsarray<object>optional
500Returned when a server-side problem prevents the custom field from being updated.
errorsarray<object>optional

Error handling

A 400 is returned when a parameter or request value is missing or malformed. A 401 is returned without a valid authentication token, a 403 when the authenticated user lacks access or the required custom_fields:write scope, a 404 when the custom field does not exist, and a 500 for a server-side failure. Do not attempt to update type or enum_options with this endpoint.