Uninstall an app from a workspace | Sample

3 parameters

tokenstringoptional

Authentication token for the app; the required scope is `none`.

client_idstringoptional

Application identifier issued when the app was created.

client_secretstringoptional

Application secret issued when the app was created.

2 status codes

200Returns an object with `ok` set to true confirming that the app was uninstalled.

okbooleanrequired

Allowed:true

defaultReturned when the application credentials, authentication, authorization, or request parameters are invalid; the response contains `ok` set to false and an `error` value.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:invalid_client_idbad_client_secretclient_id_token_mismatchnot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arg

okbooleanrequired

Allowed:false

Error handling

Use a valid token when authenticating the request with a token. When using application credentials instead, client_id and client_secret must be the values issued for the application.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.appsUninstall.list({
  token: "sk_live_4eC39Hq",
  clientId: "c0a80123-4567-89ab-cdef-0123456789ab",
  clientSecret: "sk_live_4eC39Hq",
});

{
  "ok": true
}

Request

Response

Errors