Skip to content

Function: deleteAddonProperty() ​

ts
function deleteAddonProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

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

Deletes an app's property.

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 ​

ParameterTypeDescription
clientClient-
parameters{ addonKey: string; propertyKey: string; }-
parameters.addonKeystringThe key of the app, as defined in its descriptor.
parameters.propertyKey?stringThe key of the property.
options?RequestOptions-

Returns ​

Promise<void>