Issue fields

Update custom field

Updates a custom field.

Permissions required: Administer Jira global permission.

put/rest/api/3/field/{fieldId}

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/field/{fieldId}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

Path parameters

fieldIdstring required

The ID of the custom field.

Request body

descriptionstring

The description of the custom field. The maximum length is 40000 characters.

namestring

The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.

searcherKey'com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher' | 'com.atlassian.jira.plugin.system.customfieldtypes:daterange' | 'com.atlassian.jira.plugin.system.customfieldtypes:datetimerange' | 'com.atlassian.jira.plugin.system.customfieldtypes:exactnumber' | 'com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher' | 'com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher' | 'com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher' | 'com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher' | 'com.atlassian.jira.plugin.system.customfieldtypes:numberrange' | 'com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher' | 'com.atlassian.jira.plugin.system.customfieldtypes:textsearcher' | 'com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher' | 'com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher'

The searcher that defines the way the field is searched in Jira. It can be set to null, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):

  • cascadingselect: cascadingselectsearcher
  • datepicker: daterange
  • datetime: datetimerange
  • float: exactnumber or numberrange
  • grouppicker: grouppickersearcher
  • importid: exactnumber or numberrange
  • labels: labelsearcher
  • multicheckboxes: multiselectsearcher
  • multigrouppicker: multiselectsearcher
  • multiselect: multiselectsearcher
  • multiuserpicker: userpickergroupsearcher
  • multiversion: versionsearcher
  • project: projectsearcher
  • radiobuttons: multiselectsearcher
  • readonlyfield: textsearcher
  • select: multiselectsearcher
  • textarea: textsearcher
  • textfield: textsearcher
  • url: exacttextsearcher
  • userpicker: userpickergroupsearcher
  • version: versionsearcher

Response

Returned if the request is successful.

unknown required

Changes

No recorded changes to this operation across all 36 revisions of this API.