Set app property (Forge)

PUT

/rest/forge/1/app/properties/{propertyKey}

Sets the value of a Forge app's property.
These values can be retrieved in Jira expressions
through the app context variable.
They are also available in entity property display conditions.

For other use cases, use the Storage API.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Only Forge apps can make this request.

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/rest/forge/1/app/properties/' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Response Example

200 - Success

{
    "message": "Property updated.",
    "statusCode": 200
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned if the property is updated.

Body

🟢201Created

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-16 07:18:01

Delete app property (Forge)

Remove modules