PUT /rest/api/2/field/{fieldKey}/option/{optionId}
Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.
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.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
fieldKey |
String | Yes |
The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the
|
optionId |
Integer | Yes |
The ID of the option to be updated. |
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 |
|---|---|---|---|
id |
Integer | Yes |
The unique identifier for the option. This is only unique within the select field's set of options. |
properties |
Object | No |
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) are defined in the descriptor for the issue field module. |
config |
Object | No |
Details of the projects the option is available in. |
config.attributes[] |
Array | No |
DEPRECATED |
value |
String | Yes |
The option's name, which is displayed in Jira. |
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.