App Installation

promoteVersion

Update an installed app to a new version

post/v1/app/{appId}/promote-to/{version}

Path parameters

appIdstring required
versionstring required

Response

App successfully promoted to new version

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"
  ]
}

Changes

Changed in 3 of the 10 revisions of this API.4210

  • d6e3c1e0a11b316See the full diff
    • added ErpInformToolkitComponent to the components/items/allOf[subschema #2]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • the components/items/allOf[BaseComponentCommon]/options/items/value response's property type/format changed from string/ to string boolean number/ for status 200

      response-property-type-changed

    • the option_values/items/options/items/value response's property type/format changed from string/ to string boolean number/ for status 200

      response-property-type-changed

    • removed the optional property components/items/allOf[subschema #2]/oneOf[CustomFlowActionComponent]/configuration/oneOf[ExternalIntegrationCustomActionConfig]/allOf[subschema #2]/external_integration_settings/auth_token_ref from the response with the 200 status

      response-optional-property-removed

    • added the optional property blueprint_ref to the response with the 200 status

      response-optional-property-added

    • added the optional property components/items/allOf[BaseComponentCommon]/surfaces to the response with the 200 status

      response-optional-property-added

    • added the optional property components/items/allOf[subschema #2]/oneOf[CustomFlowActionComponent]/surfaces to the response with the 200 status

      response-optional-property-added

    • added the optional property components/items/allOf[subschema #2]/oneOf[JourneyBlockComponent]/configuration/override_dev_mode to the response with the 200 status

      response-optional-property-added

    • added the optional property owner_org_id to the response with the 200 status

      response-optional-property-added

    • added ERP_INFORM_TOOLKIT discriminator mapping keys to the components/items/allOf[subschema #2]/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 2ab2aaf08d93113See the full diff
    • added CustomFlowActionComponent to the components/items/allOf[subschema #2]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • added the new number enum value to the components/items/allOf[subschema #2]/oneOf[JourneyBlockComponent]/configuration/component_mapping/additionalProperties/ response property for the response status 200

      response-property-enum-value-added

    • added the optional property _manifest to the response with the 200 status

      response-optional-property-added

    • added the optional property role to the response with the 200 status

      response-optional-property-added

    • added CUSTOM_FLOW_ACTION discriminator mapping keys to the components/items/allOf[subschema #2]/ response property for the response status 200

      response-property-discriminator-mapping-added

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog