---
name: "disableRule"
mode: "api"
versionRequirements:
  - { name: "Base Library", version: "2.14.0" }
title: "device.disableRule - 停用联动规则"
---

## disableRule

> [VERSION] Base Library >= 2.14.0

### Description

Disable automation rule

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `IRuleIdOption` | Yes | Includes rule ID |

### Return Value

Type: `Promise<boolean>`

Whether disabling succeeded

### Referenced Types

##### `interface` IRuleIdOption

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `ruleId` | `string` | Yes | Rule ID |


### Examples

#### Disable automation rule

```ts
ty.disableRule({
  ruleId: 'rule_001',
}).then((success) => {
  console.log('Disable result', success);
});
```