API Reference

Update a BusinessRule

put
https://api.vcita.biz/v3/ai/business_rules/

Overview

Update an existing business rule by UID. All fields are optional - only provided fields will be updated.

Available for Staff tokens.

Path Params
string
required

Unique identifier of the business rule

Body Params
string

The content or text of the business rule (e.g., "Always maintain a warm, friendly, and professional tone in all client communications").

string
enum

The status of the business rule.

Available values:

  • active - The rule is in effect and used by the AI agent.
  • pending_approval - The rule is awaiting staff review.
  • inactive - The rule is deactivated and not used by the AI agent.
Allowed:
integer

Sort order for displaying rules within a category (e.g., 0). Lower values appear first.

string
enum

The category code of the business rule. Determines how the AI agent uses this rule.

Available values:

  • tone_of_voice - Rules about communication style and tone.
  • policies_and_info - Rules about business operations and policies.
  • things_to_avoid - Rules about what the AI should not do or say.
  • faq - Frequently asked questions and their answers.
  • client_facing_bot_policies - Rules specifically for client-facing bot interactions.
Allowed:
Responses

Updated about 1 month ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago