Bulk Import BusinessRules

Overview

Create an async job to extract business rules from raw text using LLM. The system analyzes content, extracts rules, classifies by category, and deduplicates against existing rules.

Webhook Notification

When the job completes, a webhook notification will be sent to subscribers of the business_rules_bulk_import/completed event. The webhook payload includes the complete list of created business rules.

To receive notifications:

  1. Subscribe to the webhook event: POST /platform/v1/webhook/subscribe with {"event": "business_rules_bulk_import/completed", "target_url": "https://your-domain.com/webhook"}
  2. Your webhook will receive the job results including all created business rules

Webhook Payload Structure:

{
  "event": "business_rules_bulk_import/completed",
  "data": {
    "job_uid": "job-xxx",
    "business_uid": "biz-xxx",
    "status": "completed",
    "business_rules": [
      {
        "uid": "br-xxx",
        "content": "Rule content",
        "category_code": "policies_and_info",
        "status": "pending_approval",
        "created_at": "2026-03-01T10:30:00.000Z"
      }
    ],
    "created_rules": 15,
    "skipped_duplicates": 8
  }
}

Available for Staff tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 102400

Raw unstructured text content to analyze for rule extraction (e.g., business profile, email threads, policy documents). Maximum 100KB.

string
enum

The category of business rules to extract from the content. All extracted rules will be assigned to this category. If no category supplied, the system will attempt to infer the category based on the content.

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:
string
length ≤ 1000

Optional description of the content structure to help LLM understand the format (e.g., "Structured business profile from onboarding intake. Fields: business identity, hours, About Us narrative, services list, service area, special notes.").

string
length ≤ 2000

Optional instructions for the LLM on how to extract and categorize rules from the content (e.g., "Extract FAQ pairs from services. Infer tone from About Us. Special Notes become individual policies_and_info rules.").

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json