Clarify

POST

https://api.main.xleadfunnel.com/v1/lead-forms/clarify

Continue a draft after need_clarification (SSE). Terminal is rc 110 or 120; then Clarify again or Confirm.

Request

Body Params application/json

Example

// Add to join a particular form
{
    "draft_id": "a1b2c3d4e5f6789012345678abcdef01", // Required: identifies the draft being refined
    "lang": "tc",
    "answers": [
        {
            "id": "q_event_dates",
            "choice": "B"
        },
        {
            "id": "q_pricing_unit",
            "choice": "A",
            "text": "每組 1200 元，含一位家長一位小孩，加一人 400"
        }, // choice + detail
        {
            "id": "q_address",
            "text": "台北市大安區四維路 88 號 2 樓，線上刷卡或匯款都可以"
        }
    ],
    // Optional: extra requirements applied on top of the answers above
    "additional_prompt": "小孩要 4 歲以上。表單開頭幫我寫一段溫馨的介紹，主打親子一起動手做。"
}

Responses

🟢200Success

application/json

Bodyapplication/json

Examples

Needs to ClarifyReady to ConfirmSuccessError

action_type :
'set_value' let user pick one option as value
'append_note' allows user to further supplement description

// Prompts to user to answer questions
{
    "rc": 100,
    "rm": "User needs further clarify questions",
    "status": "clarify", // Still incomplete; another clarify call is needed
    "draft_id": "a1b2c3d4e5f6789012345678abcdef01",
    "type": "event",
    "questions": [
        {
            "id": "q_address", // Re-issued; read the id from THIS response, never cache it
            "title": "教室完整地址與付款方式？",
            "reason": "報名頁需要顯示地址；付款方式決定是否啟用線上金流。",
            "choices": []
        }
    ],
    "credits_used": 15,
    "remaining_credits": 4855
}

Modified at 2026-07-31 04:31:52

Create

Confirm