App and Solution
Apps

Update App Attributes

3min
overview the updateapp api allows developers to add, modify, or remove app attributes in one api call what can developers update? 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 true false 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 allow deny 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 mobile apps specify the packagename in the format common to the platform (e g , com example appname) if the packagename is left undefined, the api will use the listingid to generate the url example com getos1 mobile vans trackers\ //auth apps getos1 com/auth/realms/dpdevsb1/android/com getos1 mobile vans trackers/callback web apps use the packagename to define a custom redirect urls (e g , com example test) if the packagename is left undefined, then the api will not generate a redirect url required attributes 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 { "displayname" "advanced vehicle tracker", "shortdescription" "an advanced solution for tracking vehicles in real time " }