Delete issue field option

DELETE

/rest/api/3/field/{fieldKey}/option/{optionId}

Deletes an option from a select list issue field.

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'http://jira.local:8080/jira/rest//rest/api/3/field//option/'

Response Example

204 - Example 1

null

Request

Path Params

fieldKey

string

required

The field key is specified in the following format: $(a pp - k ey)__$ (field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.

run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

optionId

integer

required

The ID of the option to be deleted.

Responses

🟢204Returned if the field option is deleted.

application/json

Body

No schema defined

🟠403Returned if the request is not authenticated as a Jira administrator or the app that provided the field.

🟠404Returned if the field or option is not found.

🟠409Returned if the option is selected for the field in any issue.

Modified at 2023-07-13 03:27:27

Update issue field option

Replace issue field option