> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs-parschat.parstechai.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs-parschat.parstechai.com/_mcp/server.

# Update a rule

PATCH https://api-chat.parstechai.com/v1/robots/{robot_id}/channels/{channel_id}/rules/{rule_id}
Content-Type: application/json

Updates the fields you send and leaves the rest alone. Send `is_active: false` to pause a rule without deleting it.

Reference: https://docs-parschat.parstechai.com/api-reference/instagram-automation/update-rule

## Authentication

- `Authorization` header (bearer token, required) — Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as `Authorization: Bearer pk_live_…`.

## Request

### Path parameters

- `robot_id` (string, required) — The robot's id, as returned by the create call.
- `channel_id` (string, required) — The channel's id.
- `rule_id` (string, required) — The rule's id.

### Body (application/json)

This endpoint expects a Rule.

- `id` (string, optional) — ParsChat identifier for the rule.
- `name` (string, optional) — Your label for the rule. Shown in the panel.
- `trigger` (Trigger, optional) — What makes a rule fire.
- `actions` (list of Action, optional) — What to send on a DM rule.
- `reply_in_comment` (RuleReplyInComment, optional) — Comment rules only. Posts a public reply under the comment.
- `then_send_dm` (list of Action, optional) — Comment rules only. Follows the public reply with a private message.
- `require_follow` (RequireFollow, optional) — Withhold the reply until the commenter follows the page. The verification round-trip is ours: you do not implement it.
- `is_active` (boolean, optional, default: true) — Whether the rule is currently firing.
- `created_at` (datetime, optional) — When the rule was created.

## Response

### 200

The updated rule.

- `id` (string, optional) — ParsChat identifier for the rule.
- `name` (string, optional) — Your label for the rule. Shown in the panel.
- `trigger` (Trigger, optional) — What makes a rule fire.
- `actions` (list of Action, optional) — What to send on a DM rule.
- `reply_in_comment` (RuleReplyInComment, optional) — Comment rules only. Posts a public reply under the comment.
- `then_send_dm` (list of Action, optional) — Comment rules only. Follows the public reply with a private message.
- `require_follow` (RequireFollow, optional) — Withhold the reply until the commenter follows the page. The verification round-trip is ours: you do not implement it.
- `is_active` (boolean, optional, default: true) — Whether the rule is currently firing.
- `created_at` (datetime, optional) — When the rule was created.

## Errors

### 400 Bad Request Error

The request itself is malformed: a parameter is missing, unparseable, or out of range. Unlike 422, the request never reached validation of its contents.

- `error` (ErrorError, optional)

### 401 Unauthorized Error

The key is missing, wrong, revoked, or past its expiry date. All four answer `invalid_key`: telling an expired key from an unknown one would confirm to whoever holds a leaked key that it was once real.

- `error` (ErrorError, optional)

### 403 Forbidden Error

The call is understood but not permitted: a missing role, a lapsed plan, or exhausted capacity.

- `error` (ErrorError, optional)

### 404 Not Found Error

No such resource, or it belongs to another partner. We return 404 rather than 403 here, because a 403 would confirm the id exists.

- `error` (ErrorError, optional)

### 422 Unprocessable Entity Error

The payload is malformed, or a prerequisite is not configured.

- `error` (ErrorError, optional)

### 429 Too Many Requests Error

You are calling the API too fast. `details` names the limit you are held to. This never means an automated reply to an end customer was discarded: those are queued, not dropped.

- `error` (ErrorError, optional)

### 500 Internal Server Error

Something failed on our side. Retry with backoff, and quote `request_id` if it persists.

- `error` (ErrorError, optional)

### 503 Service Unavailable Error

A service we depend on (a channel provider, or our AI service) is unavailable. Retry with backoff.

- `error` (ErrorError, optional)

## Types

### Trigger

What makes a rule fire.

- `on` (enum, required) — `dm` matches direct messages. `comment` matches comments on posts and reels.
  - Allowed values: `dm`, `comment`
- `keywords` (list of string, required) — Words that trigger the rule. At least one is required.
- `match` (enum, optional, default: contains) — `contains` matches a keyword anywhere in the text. `equal` requires the whole message to match.
  - Allowed values: `contains`, `equal`
- `media_id` (string, optional) — Comment rules only. Scopes the rule to one post or reel. Omit it and the rule applies to every post. Get ids from the media endpoint.

### Action

One step of a reply. The vocabulary is closed: an unknown `type` returns 422, so new action types can be added without breaking a partner who guessed.

- `type` (enum, required) — Which kind of step this is.
  - Allowed values: `text`, `image`, `link`, `delay`
- `body` (string, optional) — Message text. Required when `type` is `text`.
- `url` (string, optional) — Destination for a `link`, or the image source for an `image`.
- `label` (string, optional) — Button label for a `link`.
- `seconds` (integer, optional) — How long to wait. Used when `type` is `delay`.

### RuleReplyInComment

Comment rules only. Posts a public reply under the comment.

- `body` (string, optional) — The public reply text.

### RequireFollow

Withhold the reply until the commenter follows the page. The verification round-trip is ours: you do not implement it.

- `enabled` (boolean, optional) — Whether the gate applies to this rule.
- `prompt` (string, optional) — Sent instead of the reply when the sender does not follow.
- `button_text` (string, optional) — Label on the postback button, tapped inside Instagram.
- `retry_prompt` (string, optional) — Sent when someone taps the button before actually following.

### ErrorError

- `code` (string, optional) — Stable machine-readable code. Branch on this, not on the message.
- `message` (string, optional) — Human-readable explanation. Wording may change.
- `request_id` (string, optional) — Log this. It is what lets support find your exact request.
- `details` (map from string to any, optional) — Machine-readable context for the code. On `capacity_exhausted` it carries `occupied`, `requested` and `capacity`; on `rate_limited`, `limit_per_minute` and `window_seconds`.

## Examples

### Pause a rule

**Request**

```json
{
  "is_active": false
}
```

**Response**

```json
{
  "id": "rul_7nQ2xK",
  "name": "Price enquiry to catalogue",
  "trigger": {
    "on": "dm",
    "keywords": [
      "price",
      "how much",
      "cost"
    ],
    "match": "contains"
  },
  "actions": [
    {
      "type": "text",
      "body": "Hello! Here is our catalogue."
    },
    {
      "type": "link",
      "url": "https://shop.example/catalogue",
      "label": "Catalogue"
    }
  ],
  "is_active": false,
  "created_at": "2026-09-20T11:12:00Z"
}
```

**SDK Code**

```python Pause a rule
import requests

url = "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK"

payload = { "is_active": False }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Pause a rule
const url = 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"is_active":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Pause a rule
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK"

	payload := strings.NewReader("{\n  \"is_active\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Pause a rule
require 'uri'
require 'net/http'

url = URI("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_active\": false\n}"

response = http.request(request)
puts response.read_body
```

```java Pause a rule
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_active\": false\n}")
  .asString();
```

```php Pause a rule
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK', [
  'body' => '{
  "is_active": false
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Pause a rule
using RestSharp;

var client = new RestClient("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"is_active\": false\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Pause a rule
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["is_active": false] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Change the keywords

**Request**

```json
{
  "trigger": {
    "on": "dm",
    "keywords": [
      "price",
      "cost"
    ],
    "match": "contains"
  }
}
```

**Response**

```json
{
  "id": "rul_7nQ2xK",
  "name": "Price enquiry to catalogue",
  "trigger": {
    "on": "dm",
    "keywords": [
      "price",
      "cost"
    ],
    "match": "contains"
  },
  "actions": [
    {
      "type": "text",
      "body": "Hello! Here is our catalogue."
    },
    {
      "type": "link",
      "url": "https://shop.example/catalogue",
      "label": "Catalogue"
    }
  ],
  "is_active": true,
  "created_at": "2026-09-20T11:12:00Z"
}
```

**SDK Code**

```python Change the keywords
import requests

url = "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK"

payload = { "trigger": {
        "on": "dm",
        "keywords": ["price", "cost"],
        "match": "contains"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Change the keywords
const url = 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"trigger":{"on":"dm","keywords":["price","cost"],"match":"contains"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Change the keywords
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK"

	payload := strings.NewReader("{\n  \"trigger\": {\n    \"on\": \"dm\",\n    \"keywords\": [\n      \"price\",\n      \"cost\"\n    ],\n    \"match\": \"contains\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Change the keywords
require 'uri'
require 'net/http'

url = URI("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"trigger\": {\n    \"on\": \"dm\",\n    \"keywords\": [\n      \"price\",\n      \"cost\"\n    ],\n    \"match\": \"contains\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Change the keywords
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"trigger\": {\n    \"on\": \"dm\",\n    \"keywords\": [\n      \"price\",\n      \"cost\"\n    ],\n    \"match\": \"contains\"\n  }\n}")
  .asString();
```

```php Change the keywords
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK', [
  'body' => '{
  "trigger": {
    "on": "dm",
    "keywords": [
      "price",
      "cost"
    ],
    "match": "contains"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Change the keywords
using RestSharp;

var client = new RestClient("https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"trigger\": {\n    \"on\": \"dm\",\n    \"keywords\": [\n      \"price\",\n      \"cost\"\n    ],\n    \"match\": \"contains\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change the keywords
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["trigger": [
    "on": "dm",
    "keywords": ["price", "cost"],
    "match": "contains"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-chat.parstechai.com/v1/robots/rbt_8fK2mQ/channels/chn_3pQ7xL/rules/rul_7nQ2xK")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```