App Installation

install

Upsert app installation by its ID.

post/v1/app/{appId}

Path parameters

appIdstring required

Request body

Response

App successfully installed.

app_idstring required

ID of the app configuration

installer_org_idstring required

Unique identifier for the organization the app is installed in

enabledboolean required

Flag to indicate if the app is enabled. Enabled is set to true when required option values are set.

namestring required

Name of the app

installed_versionstring required

Version of the app that is installed

Example response

{
  "components": [
    {
      "configuration": {
        "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js"
      }
    }
  ]
}

Changes