Sign in

v10

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-19274659.0 KB
App Installation

install

Upsert app installation by its ID.

post/v1/app/{appId}

Path parameters

appIdstring required

Request body

versionstring

Version of the app to update to

_manifeststring[]

Manifest ID used to create/update the entity

Example request

{
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

owner_org_idstring

Organization ID of the app creator

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

rolestring

The name of the role the app can use to access APIs

_manifeststring[]

Manifest ID used to create/update the entity

Example response

{
  "components": [
    {
      "configuration": {
        "override_dev_mode": {
          "override_url": "http://localhost:3000"
        },
        "component_url": "https://cdn.apps.com/123/v1.0.0/bundle.js"
      }
    }
  ],
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}