---
title: "Create issue field option"
method: POST
path: "/rest/api/2/field/{fieldKey}/option"
tags: ["Issue custom field options (apps)"]
---

# Create issue field option

`POST /rest/api/2/field/{fieldKey}/option`

Creates an option for 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](#api-group-Issue-custom-field-options) resource.

Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.

## Path parameters

- `fieldKey` string, required

## Request body

- IssueFieldOptionCreateBean
  - `config` IssueFieldOptionConfiguration — Details of the projects the option is available in.
    - `attributes` string[] — DEPRECATED
    - `scope` IssueFieldOptionScopeBean
      - `global` GlobalScopeBean
        - `attributes` string[] — Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
      - `projects` integer[] — DEPRECATED
      - `projects2` ProjectScopeBean[] — Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.
        - `attributes` string[] — Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
        - `id` integer — The ID of the project that the option's behavior applies to.
  - `properties` object — The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.
  - `value` string, required — The option's name, which is displayed in Jira.

## Response `200`

Returned if the request is successful.

- IssueFieldOption — Details of the options for a select list issue field.
  - `config` IssueFieldOptionConfiguration — Details of the projects the option is available in.
    - `attributes` string[] — DEPRECATED
    - `scope` IssueFieldOptionScopeBean
      - `global` GlobalScopeBean
        - `attributes` string[] — Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
      - `projects` integer[] — DEPRECATED
      - `projects2` ProjectScopeBean[] — Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.
        - `attributes` string[] — Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
        - `id` integer — The ID of the project that the option's behavior applies to.
  - `id` integer, required — The unique identifier for the option. This is only unique within the select field's set of options.
  - `properties` object — The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see [Issue Field Option Property Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module.
  - `value` string, required — The option's name, which is displayed in Jira.

## Other responses

- `400` — Returned if the option is invalid.
- `403` — Returned if the request is not authenticated as a Jira administrator or the app that provided the field.
- `404` — Returned if the field is not found or does not support options.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api/versions/a26541c2f8bd/schema)