setAppFunctionEnabled

Requires permission settings:apps:install.

Switch one of an installed app's functions off or back on. Off, ARC's default behaviour runs instead; only a function an admin switched off can be switched on here.

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 SetAppFunctionEnabled($enabled: Boolean!, $hook: String!, $installationId: ID!) {
  setAppFunctionEnabled(
    enabled: $enabled
    hook: $hook
    installationId: $installationId
  ) {
    activationId
    appVersionId
    disabledReason
    enabled
    hook
    updatedAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetAppFunctionEnabled($enabled: Boolean!, $hook: String!, $installationId: ID!) {\n  setAppFunctionEnabled(\n    enabled: $enabled\n    hook: $hook\n    installationId: $installationId\n  ) {\n    activationId\n    appVersionId\n    disabledReason\n    enabled\n    hook\n    updatedAt\n  }\n}",
  "variables": {
    "enabled": true,
    "hook": "string",
    "installationId": "id"
  }
}
EOF

Variables:

{
  "enabled": true,
  "hook": "string",
  "installationId": "id"
}

Response:

{
  "data": {
    "setAppFunctionEnabled": {
      "activationId": "id",
      "appVersionId": "id",
      "disabledReason": "string",
      "enabled": true,
      "hook": "string",
      "updatedAt": "2025-01-15T00:00:00Z"
    }
  }
}

setAppFunctionEnabled(
  enabled: Boolean!
  hook: String!
  installationId: ID!
): AppFunctionView!

Arguments

setAppFunctionEnabled.enabled ● Boolean! non-null scalar

True to switch on, false to switch off.

setAppFunctionEnabled.hook ● String! non-null scalar

The function's hook, e.g. delivery.options.filter.

setAppFunctionEnabled.installationId ● ID! non-null scalar

The installation the function belongs to.

Type

AppFunctionView object

One function an installed app runs inside ARC (a hook such as delivery.options.filter), and whether it is on.