Update App Attributes
The UpdateApp API allows developers to add, modify, or remove app attributes in one API call.
Comprehensive Updates: Developers can add, modify, or remove one or more attributes.
Attribute Removal: null is an acceptable value to remove optional attributes. However, you cannot pass null for individual array items.
Endpoint: PATCH /developer/apps/versions/{appVersionId}
Attributes: The Update API can update all attributes except a few attributes such as listingId that are not updatable.
Parameter | Description |
|---|---|
displayName | The name that will be displayed to the users in the Console and Marketplace. |
isConsoleCompatible | Specifies if the application is console compatible. The acceptable boolean values are:
This should be set to true if an app has to be displayed in the Console. |
visibility | Specifies if the app is visible to all organizations or a few organizations in the Marketplace. |
visibility.isPrivate | Specifies if the application is visible publicly or for subscription. This value should be false if the app is visible in the Marketplace. |
visibility.permissionType | This is only applicable when isPrivate is false. Determines whether the selected orgs are permitted from viewing the application in the Marketplace. Acceptable values:
|
visibility.orgIdentifiers | Only applicable when isPrivate is false. Provides a list of organization short names where a given permission is applied. |
url | A dictionary of various supported urls for the application. |
url.relativePath | The relative path of a web application. |
url.stackId | `*` indicates the same URL on all stacks while stack_id means the URLs work only for the specific stack mentioned. |
url.server | The backend server URL will serve as baseURL for app webhooks to receive notifications. |
url.interface | Specifies the URL of the main page of the app. If there is no homepage, leave this value empty. If the homepage is the same as the relative path, use "/". |
url.admin | The URL to the admin interface, if it exists. |
url.setting | The URL for app settings page, if it exists. |
url.userGuide | The URL for the documentation home page, if it exists. |
url.gitInfo | The URL for the git repository, if it exists. |
shortDescription | A short description of the application for display on the Marketplace. |
longDescription | An extended description of the application for display on the Marketplace. |
categories | The categories that the application belongs to. This is a free-form, tag-like set of strings. |
menu | Controls how a sub-menu of an app is displayed on the Console. Only applicable to Console compatible applications. |
menu.displayName | The name of the sub-menu item within the app. |
menu.displayOrder | Controls the listing sequence of the sub-menu within an app. Assigning a numerical value like 1, 2, 3, etc., will arrange the sub-menu in that specific order within the left navigation of the Console. If this parameter is left blank or set to '0', the sub-menu will not be displayed in the menu. |
menu.relativePath | The relative path of the sub-menu item. |
packageName | The package name for mobile or web apps.
|
Required Attributes
(*) Indicates that the attribute is required.
Example Request and Response
The following example request updates displayName, shortDescription and listingId of the registered Vehicle Tracker app: