Skip to content

Function: deleteCustomFieldOption() ​

ts
function deleteCustomFieldOption(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/cloud/api/issueCustomFieldOptions.ts:202

Deletes a custom field option.

Options with cascading options cannot be deleted without deleting the cascading options first.

This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.

Permissions required:Administer Jira global permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ contextId: number; fieldId: string; optionId: number; }-
parameters.contextIdnumberThe ID of the context from which an option should be deleted.
parameters.fieldId?stringThe ID of the custom field.
parameters.optionId?numberThe ID of the option to delete.
options?RequestOptions-

Returns ​

Promise<void>