bulkUpdateTenantSettings

Requires permission settings:tenant:update.

Changes several settings in one call. A category that has its own update operation is refused. Needs settings:tenant:update.

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 BulkUpdateTenantSettings($input: BulkUpdateSettingsInput!) {
  bulkUpdateTenantSettings(input: $input) {
    id
    createdAt
    category
    dataType
    description
    enteredBy
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation BulkUpdateTenantSettings($input: BulkUpdateSettingsInput!) {\n  bulkUpdateTenantSettings(input: $input) {\n    id\n    createdAt\n    category\n    dataType\n    description\n    enteredBy\n  }\n}",
  "variables": {
    "input": {
      "settings": [
        {
          "id": "string"
        }
      ]
    }
  }
}
EOF

Variables:

{
  "input": {
    "settings": [
      {
        "id": "string"
      }
    ]
  }
}

Response:

{
  "data": {
    "bulkUpdateTenantSettings": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "category": "ACCOUNTING",
        "dataType": "ARRAY",
        "description": "string",
        "enteredBy": "string"
      }
    ]
  }
}

bulkUpdateTenantSettings(
  input: BulkUpdateSettingsInput!
): [TenantSetting!]!

Arguments

bulkUpdateTenantSettings.input ● BulkUpdateSettingsInput! non-null input

The settings to change, each with its ID and new values.

Type

TenantSetting object

A setting of the organization.