Skip to navigation

update

View as Markdown

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.

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

Request

This endpoint expects an object.

Response headers

Content-Lengthinteger
ConnectionstringOptional

Response

success

Errors

500
Internal Server Error