Skip to main content

updateWorkflowSettings

Requires at least one of the permissions settings:tenant:update or settings:workflows:update.

Updates the workflow settings: whether workflows are on, the auto-approve threshold, required comments, approval and rejection notices, escalation and its timeout, parallel approvals, delegation and history. Returns the saved settings. Needs settings:workflows:update, or 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:

mutation UpdateWorkflowSettings($input: WorkflowSettingsInput!) {
  updateWorkflowSettings(input: $input) {
    id
    createdAt
    category
    dataType
    description
    enteredBy
  }
}

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "updateWorkflowSettings": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "category": "ACCOUNTING",
        "dataType": "ARRAY",
        "description": "string",
        "enteredBy": "string"
      }
    ]
  }
}
updateWorkflowSettings(
  input: WorkflowSettingsInput!
): [TenantSetting!]!

Arguments​

updateWorkflowSettings.input ● WorkflowSettingsInput! non-null input​

The workflow settings to change; fields left out stay as they are.

Type​

TenantSetting object​

A setting of the organization.