v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issue custom field options (apps)

Delete issue field option

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.

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

Path parameters

fieldKeystring required

The field key is specified in the following format: $(app-key)__$(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"
optionIdinteger required

The ID of the option to be deleted.

Response

Returned if the field option is deleted.

{"stackTrail":"paths:/rest/api/3/field/{fieldKey}/option/{optionId}:delete:responses:204:content:application/json:schema","oasType":"schema","type":"unknown"}