Function: putAddonProperty()

function putAddonProperty(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  message: string;
  statusCode: number;
}>;

Defined in: src/cloud/api/appProperties.ts:73

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).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ addonKey: string; body: Record<string, any>; propertyKey: string; }	-
parameters.addonKey	string	The key of the app, as defined in its descriptor.
parameters.body?	Record<string, any>	-
parameters.propertyKey?	string	The key of the property.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; message: string; statusCode: number; }>