BotBye APIProtectionCustom Rules

set isActive

View as Markdown
### Update Rule Active Status This endpoint allows the user to update the active status of a specific rule within a project. The HTTP PATCH request should be made to `{base_url}/api/v1/{account_id}/projects/{project_id}/rules/{rule_id}/active`. #### Request - `base_url` (string): The base URL of the API. - `account_id` (string): The unique identifier of the account. - `project_id` (string): The unique identifier of the project. - `rule_id` (string): The unique identifier of the rule. #### Request Body - isActive: (boolean) Indicates the new active status of the rule. #### Response `200` with an empty JSON object — this endpoint returns no data. ``` json {} ``` > **Accepted permissions** > `Project → Project → Custom rules → Update` > > **Token scope** > `Project Action`

Authentication

X-Api-Keystring
Personal access token. Create it in your BotBye account under **Profile → Personal Access Tokens**, tick the scopes the endpoints you call require (see each endpoint's **Token scope**), and send the token in the `X-Api-Key` request header. A token works only for the account it was created in.

Path parameters

account_idstringRequired
project_idstringRequired
rule_idstringRequired

Request

This endpoint expects an object.
isActivebooleanRequired

Response headers

Content-Lengthinteger
ConnectionstringOptional

Response

success

Errors

500
Internal Server Error