Quote a campaign
quote_campaignChecks a campaign BEFORE launching it, for free: every problem at once (not just the first), any adjustments we would make, the flat price that launching would charge, and whether your balance covers it (and by how much it is short). For targeted campaigns pass cohortSize (the number of people), never the addresses. Always quote before launch_campaign.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | open_link: a share link anyone can answer, closing at responseCap — put it in your own post-purchase email. targeted: we email one invitation per address in cohortEmails. | |
| title | Yes | Shown to participants, e.g. 'How was your order?' | |
| apiKey | Yes | Your Clearvoyance API key (cv_live_… or cv_test_…), from create_account | |
| giftText | No | Shown to a participant after answering: a promo code, a thank-you, a link. Optional. | |
| questions | Yes | 1–10 questions participants answer by voice or text. No links or phone numbers. | |
| cohortSize | No | targeted only: how many people you will invite (10–200). The number, not the addresses. | |
| minPercent | No | targeted only: results unlock once this share of the list has answered. Floored at 50. | |
| senderName | No | Who is asking, as participants see it (your shop or product name). Required for open_link. | |
| description | Yes | What you want to learn. Steers the AI analysis; participants do not see it. | |
| responseCap | No | open_link only: 10, 50, 100 or 200 — the link closes at that many answers. Sets the tier: $4.99 / $17.99 / $29.99 / $49.99. | |
| expiresInDays | No | 1–42. Default 14 for open_link, 7 for targeted. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes |