setAppInstallationPaused

Requires permission settings:apps:install.

Pause or resume an installed app. A paused app's requests are refused; nothing is revoked.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SetAppInstallationPaused($installationId: ID!, $paused: Boolean!) {
  setAppInstallationPaused(installationId: $installationId, paused: $paused) {
    id
    status
    appId
    appVersionId
    grantedScopes
    installedAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetAppInstallationPaused($installationId: ID!, $paused: Boolean!) {\n  setAppInstallationPaused(installationId: $installationId, paused: $paused) {\n    id\n    status\n    appId\n    appVersionId\n    grantedScopes\n    installedAt\n  }\n}",
  "variables": {
    "installationId": "id",
    "paused": true
  }
}
EOF

Variables:

{
  "installationId": "id",
  "paused": true
}

Response:

{
  "data": {
    "setAppInstallationPaused": {
      "id": "id",
      "status": "string",
      "appId": "id",
      "appVersionId": "id",
      "grantedScopes": [
        "string"
      ],
      "installedAt": "2025-01-15T00:00:00Z"
    }
  }
}

setAppInstallationPaused(
  installationId: ID!
  paused: Boolean!
): AppInstallationView!

Arguments

setAppInstallationPaused.installationId ● ID! non-null scalar

The installation to pause or resume.

setAppInstallationPaused.paused ● Boolean! non-null scalar

True to pause, false to resume.

Type

AppInstallationView object

One app installed in this organization. The app acts as its own user, with only the access granted here.