Management

Start Uninstallation

Changed on

Starts the uninstallation workflow and stores the initial execution state.

post/installation/uninstallation

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /installation/uninstallation
  • Auth: OAuth 2 (client credentials, token URL https://ims-na1.adobelogin.com/ims/token/v3, scopes: AdobeID, openid)

Headers

x-gw-ims-org-idstring required

Adobe IMS organization ID that identifies the organization for the request.

Request body

commerceBaseUrlstring required
commerceEnv'paas' | 'saas' required
ioEventsUrlstring required
ioEventsEnvstring required

Response

The uninstallation workflow was accepted and queued for asynchronous execution.

messagestring required
activationIdstring required
idstring required
status'in-progress' required
startedAtstring date-time required
configobject

The validated app configuration recorded at install time. Present so uninstallation can be sourced from what was actually installed rather than the current request config. Absent on states persisted before this field was introduced.

dataobject nullable required

Changes