> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api-docs.botbye.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.botbye.com/_mcp/server. # update PUT {base_url}/api/v1/{account_id}/projects/{project_id}/rules Content-Type: application/json ### Update Project Rules This endpoint allows updating rules for a specific project within the account. **Request Body** - `id` (string): A unique identifier for the rule. - `name` (string): The name of the rule. - `action` (string): The action to be performed by the rule (e.g., "block"). - `isActive` (boolean): Indicates whether the rule is active. - `condition` (object): The condition under which the rule will be triggered. - `fieldName` (string): The field name to be evaluated for the condition. - `predicate` (string): The comparison predicate (e.g., "EQ" for equal). - `value` (string): The value to be compared for the condition. - `type` (string): The type of condition (e.g., "criteria"). **Response** The response will be an empty object upon successful update of the project rules. Reference: https://api-docs.botbye.com/bot-bye-api/protection/custom-rules/update ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/{account_id}/projects/{project_id}/rules: put: operationId: update summary: update description: >- ### Update Project Rules This endpoint allows updating rules for a specific project within the account. **Request Body** - `id` (string): A unique identifier for the rule. - `name` (string): The name of the rule. - `action` (string): The action to be performed by the rule (e.g., "block"). - `isActive` (boolean): Indicates whether the rule is active. - `condition` (object): The condition under which the rule will be triggered. - `fieldName` (string): The field name to be evaluated for the condition. - `predicate` (string): The comparison predicate (e.g., "EQ" for equal). - `value` (string): The value to be compared for the condition. - `type` (string): The type of condition (e.g., "criteria"). **Response** The response will be an empty object upon successful update of the project rules. tags: - subpackage_customRules parameters: - name: account_id in: path required: true schema: type: string - name: project_id in: path required: true schema: type: string responses: '200': description: success content: application/json: schema: $ref: '#/components/schemas/Custom rules_update_Response_200' '500': description: fail content: application/json: schema: $ref: '#/components/schemas/UpdateRequestInternalServerError' requestBody: content: application/json: schema: type: object properties: {} servers: - url: '{base_url}' description: '{base_url}' components: schemas: Custom rules_update_Response_200: type: object properties: {} title: Custom rules_update_Response_200 UpdateRequestInternalServerError: type: object properties: message: type: string code: type: string type: type: string context: description: Any type required: - message - code - type title: UpdateRequestInternalServerError ``` ## Examples **Request** ```json "{\n \"id\": \"{$guid}\",\n \"name\": \"{$randomProductName}\",\n \"action\": \"block\",\n \"isActive\": {$randomBoolean},\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"{$randomIP}\",\n \"type\": \"criteria\"\n }\n}" ``` **Response** ```json {} ``` **SDK Code** ```python Custom rules_update_example import requests url = "https://{base_url}/api/v1/account_id/projects/project_id/rules" payload = "{ \"id\": \"{$guid}\", \"name\": \"{$randomProductName}\", \"action\": \"block\", \"isActive\": {$randomBoolean}, \"condition\": { \"fieldName\": \"remote_addr\", \"predicate\": \"EQ\", \"value\": \"{$randomIP}\", \"type\": \"criteria\" } }" headers = {"Content-Type": "application/json"} response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Custom rules_update_example const url = 'https://{base_url}/api/v1/account_id/projects/project_id/rules'; const options = { method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '"{\n \"id\": \"{$guid}\",\n \"name\": \"{$randomProductName}\",\n \"action\": \"block\",\n \"isActive\": {$randomBoolean},\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"{$randomIP}\",\n \"type\": \"criteria\"\n }\n}"' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Custom rules_update_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://{base_url}/api/v1/account_id/projects/project_id/rules" payload := strings.NewReader("\"{\\n \\\"id\\\": \\\"{$guid}\\\",\\n \\\"name\\\": \\\"{$randomProductName}\\\",\\n \\\"action\\\": \\\"block\\\",\\n \\\"isActive\\\": {$randomBoolean},\\n \\\"condition\\\": {\\n \\\"fieldName\\\": \\\"remote_addr\\\",\\n \\\"predicate\\\": \\\"EQ\\\",\\n \\\"value\\\": \\\"{$randomIP}\\\",\\n \\\"type\\\": \\\"criteria\\\"\\n }\\n}\"") req, _ := http.NewRequest("PUT", url, payload) 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 Custom rules_update_example require 'uri' require 'net/http' url = URI("https://{base_url}/api/v1/account_id/projects/project_id/rules") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Content-Type"] = 'application/json' request.body = "\"{\\n \\\"id\\\": \\\"{$guid}\\\",\\n \\\"name\\\": \\\"{$randomProductName}\\\",\\n \\\"action\\\": \\\"block\\\",\\n \\\"isActive\\\": {$randomBoolean},\\n \\\"condition\\\": {\\n \\\"fieldName\\\": \\\"remote_addr\\\",\\n \\\"predicate\\\": \\\"EQ\\\",\\n \\\"value\\\": \\\"{$randomIP}\\\",\\n \\\"type\\\": \\\"criteria\\\"\\n }\\n}\"" response = http.request(request) puts response.read_body ``` ```java Custom rules_update_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://{base_url}/api/v1/account_id/projects/project_id/rules") .header("Content-Type", "application/json") .body("\"{\\n \\\"id\\\": \\\"{$guid}\\\",\\n \\\"name\\\": \\\"{$randomProductName}\\\",\\n \\\"action\\\": \\\"block\\\",\\n \\\"isActive\\\": {$randomBoolean},\\n \\\"condition\\\": {\\n \\\"fieldName\\\": \\\"remote_addr\\\",\\n \\\"predicate\\\": \\\"EQ\\\",\\n \\\"value\\\": \\\"{$randomIP}\\\",\\n \\\"type\\\": \\\"criteria\\\"\\n }\\n}\"") .asString(); ``` ```php Custom rules_update_example request('PUT', 'https://{base_url}/api/v1/account_id/projects/project_id/rules', [ 'body' => '"{\\n \\"id\\": \\"{$guid}\\",\\n \\"name\\": \\"{$randomProductName}\\",\\n \\"action\\": \\"block\\",\\n \\"isActive\\": {$randomBoolean},\\n \\"condition\\": {\\n \\"fieldName\\": \\"remote_addr\\",\\n \\"predicate\\": \\"EQ\\",\\n \\"value\\": \\"{$randomIP}\\",\\n \\"type\\": \\"criteria\\"\\n }\\n}"', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Custom rules_update_example using RestSharp; var client = new RestClient("https://{base_url}/api/v1/account_id/projects/project_id/rules"); var request = new RestRequest(Method.PUT); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "\"{\\n \\\"id\\\": \\\"{$guid}\\\",\\n \\\"name\\\": \\\"{$randomProductName}\\\",\\n \\\"action\\\": \\\"block\\\",\\n \\\"isActive\\\": {$randomBoolean},\\n \\\"condition\\\": {\\n \\\"fieldName\\\": \\\"remote_addr\\\",\\n \\\"predicate\\\": \\\"EQ\\\",\\n \\\"value\\\": \\\"{$randomIP}\\\",\\n \\\"type\\\": \\\"criteria\\\"\\n }\\n}\"", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Custom rules_update_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = "{ \"id\": \"{$guid}\", \"name\": \"{$randomProductName}\", \"action\": \"block\", \"isActive\": {$randomBoolean}, \"condition\": { \"fieldName\": \"remote_addr\", \"predicate\": \"EQ\", \"value\": \"{$randomIP}\", \"type\": \"criteria\" } }" as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{base_url}/api/v1/account_id/projects/project_id/rules")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" 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() ```