Set app property

PUT

/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Sets the value of an app's property. Use this resource to store custom data for your app.

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

Permissions required: Only a Connect app whose key matches addonKey can make this request.
Additionally, Forge apps can access Connect app properties (stored against the same app.connect.key).

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned if the property is updated.

Body

🟢201Created

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success

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

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

Get app property

Delete app property (Forge)