Update custom field value

https://your-domain.atlassian.net/rest/api/3/app/field/{fieldIdOrKey}/value

Updates the value of a custom field on one or more issues. Custom fields can only be updated by the Forge app that created them. **Permissions required:** Only the app that created the custom field can update its values with this operation.

Access Token Required: API Key

Path Parameters

fieldIdOrKeystringrequired

The ID or key of the custom field. For example, `customfield_10010`.

Query Params

generateChangelogbooleanDefault: true

Whether to generate a changelog for this update.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

curl --request PUT \
     --url 'https://your-domain.atlassian.net/rest/api/3/app/field/{fieldIdOrKey}/value' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

PUT