saveAppInstallationSettings

Requires permission settings:apps:install.

Save an installed app's settings. Secrets are encrypted and never shown again.

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 SaveAppInstallationSettings($input: SaveAppSettingsInput!) {
  saveAppInstallationSettings(input: $input) {
    fields {
      type
      helpText
      key
      label
      placeholder
      required
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SaveAppInstallationSettings($input: SaveAppSettingsInput!) {\n  saveAppInstallationSettings(input: $input) {\n    fields {\n      type\n      helpText\n      key\n      label\n      placeholder\n      required\n    }\n  }\n}",
  "variables": {
    "input": {
      "installationId": "string",
      "values": [
        {
          "key": "string"
        }
      ]
    }
  }
}
EOF

Variables:

{
  "input": {
    "installationId": "string",
    "values": [
      {
        "key": "string"
      }
    ]
  }
}

Response:

{
  "data": {
    "saveAppInstallationSettings": {
      "fields": [
        {
          "type": "string",
          "helpText": "string",
          "key": "string",
          "label": "string",
          "placeholder": "string",
          "required": true
        }
      ]
    }
  }
}

saveAppInstallationSettings(
  input: SaveAppSettingsInput!
): AppSettingsFormView!

Arguments

saveAppInstallationSettings.input ● SaveAppSettingsInput! non-null input

The installation and the setting values to save. Secret values are write-only.

Type

AppSettingsFormView object

An installed app's settings form: its fields, the saved values and hints of saved secrets.