POST /rest/api/2/app/field/value
Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should be unique within the request.
Apps can only perform this operation on custom fields and custom field types declared in their own manifests.
Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.
The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
Servers
- https://your-domain.atlassian.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
generateChangelog |
Boolean | No |
Whether to generate a changelog for this update. Default value: true |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
updates[] |
Array | No | |
updates[].issueIds[] |
Array | Yes |
The list of issue IDs. |
updates[].customField |
String | Yes |
The ID or key of the custom field. For example, |
updates[].value |
Yes |
The value for the custom field. The value must be compatible with the custom field type as follows:
A list of appropriate values must be provided if the field is of the |
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.