Cloud

Jira Cloud platform / Reference / REST API v3

Issue custom field values (apps)

This resource represents the values of custom fields added by Forge apps. Use it to update the value of a custom field on issues.

Operations

POST/rest/api/3/app/field/value PUT/rest/api/3/app/field/{fieldIdOrKey}/value

POST

Update custom fields

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.

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

write:app-data:jira

Connect apps cannot access this REST resource.

Request

Query parameters

generateChangelog

boolean

Request bodyapplication/json

updates

array<MultipleCustomFieldValuesUpdate>

Responses

Returned if the request is successful.

application/json

any

POST/rest/api/3/app/field/value

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{
  "updates": [
    {
      "customField": "customfield_10010",
      "issueIds": [
        10010,
        10011
      ],
      "value": "new value"
    },
    {
      "customField": "customfield_10011",
      "issueIds": [
        10010
      ],
      "value": 1000
    }
  ]
}`;

const response = await api.asUser().requestJira(route`/rest/api/3/app/field/value`, {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

PUT

Update custom field value

Updates the value of a custom field on one or more issues.