1. Build Form
X Lead Main
  • Overview
  • API Key Integration
  • ACCOUNT
    • Get Account
      GET
  • ACCOUNT USERS
    • List Users
      GET
    • Get User
      GET
    • Get TA Lists
      GET
    • Get Tags
      GET
    • Query Users
      POST
    • Get User ID
      POST
    • Create User
      POST
    • Update User
      POST
    • Delete User
      DELETE
  • LEAD FORMS
    • Build Form
      • Create
        POST
      • Clarify
        POST
      • Confirm
        POST
    • List Users
      GET
    • Get User
      GET
  1. Build Form

Create

POST
https://api.main.xleadfunnel.com/v1/lead-forms/create
Initiate to build a form

Request

Body Params application/json

Example
// Add to join a particular form
{
    "type": "event", // One of: inquiry | event | booking | sales-page
    "lang": "tc", // Conversation and generated-copy language: tc | sc | en
    "ai_prompt": "我們是台北的烘焙教室,想在8月的週末辦親子烘焙體驗課,一次大概收10組家庭,要收報名費(用一組家庭計價)。表單要填家長姓名、手機、小孩年齡,另外想知道有沒有食物過敏。幫我做一個報名表"
}

Responses

🟢200Success
application/json
Bodyapplication/json

Examples
action_type :
'set_value' let user pick one option as value
'append_note' allows user to further supplement description
{
    "rc": 100,
    "rm": "Form requires to futher clarify",
    "status": "clarify", // clarify = answers needed before the draft can be committed
    "draft_id": "a1b2c3d4e5f6789012345678abcdef01", // 32-char hex; required in every subsequent call
    "type": "event", // Resolved type; no draft content is returned
    "questions": [
        {
            "id": "q_event_dates", // Use THIS round's id only — ids are not stable across rounds
            "title": "8 月的哪幾個週末開課?",
            "reason": "你提到「8月的週末」,但沒有指定日期與時段,無法建立場次。",
            "choices": [ // Pre-computed options rendered as cards
                {
                    "key": "A",
                    "label": "每個週六,10:00 與 14:00 各一場"
                },
                {
                    "key": "B",
                    "label": "只辦兩個週六(8/9、8/16),每天兩場"
                }
            ]
        },
        {
            "id": "q_pricing_unit",
            "title": "一組家庭的費用與包含人數?",
            "reason": "你說「用一組家庭計價」,需要金額與一組的組成才能設定收費。",
            "choices": [
                {
                    "key": "A",
                    "label": "每組固定價,含 1 大 1 小,可加購"
                },
                {
                    "key": "B",
                    "label": "每人分開計價"
                }
            ]
        },
        {
            "id": "q_address",
            "title": "教室完整地址與付款方式?",
            "reason": "報名頁需要顯示地址;付款方式決定是否啟用線上金流。",
            "choices": [] // Empty choices = free-text answer expected
        }
    ],
    "credits_used": 12,
    "remaining_credits": 4870
}
Modified at 2026-07-31 04:28:18
Previous
Delete User
Next
Clarify
Built with