PUT /rest/api/2/field/{fieldId}

Updates a custom field.

Permissions required: Administer Jira global permission.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`fieldId`	String	Yes	The ID of the custom field.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`searcherKey`	String	No	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` Possible values: `"com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"` `"com.atlassian.jira.plugin.system.customfieldtypes:datetimerange"` `"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"` `"com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher"` `"com.atlassian.jira.plugin.system.customfieldtypes:daterange"` `"com.atlassian.jira.plugin.system.customfieldtypes:exactnumber"` `"com.atlassian.jira.plugin.system.customfieldtypes:numberrange"` `"com.atlassian.jira.plugin.system.customfieldtypes:textsearcher"` `"com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher"` `"com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher"` `"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher"` `"com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher"` `"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher"`
`name`	String	No	The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.
`description`	String	No	The description of the custom field. The maximum length is 40000 characters.

searcherKey

String

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

Possible values:

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

name

String

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

description

String

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

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.