Read and manage fnlowl widgets, leads, email sequences and analytics from an AI assistant.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Activate a draft sequence so future matching leads are enrolled and may receive its emails. Activation starts timed sending with nobody watching, and the server does not itself verify human confirmation.
A project id from list_projects. Runs this call in that project instead of the connection default.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Activate a draft sequence so future matching leads are enrolled and may receive its emails. Activation starts timed sending with nobody watching, and the server does not itself verify human confirmation.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| sequenceId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sequenceId"
],
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"sequenceId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Ask the fnlowl Advisor a question in plain English. It knows how fnlowl works — widgets and where each kind appears, the embed, sequences, campaigns, sending, credits, plans, MCP — and can read the account's own widgets, leads, analytics, campaigns, sequences and sending status to answer. Suited to "how does X work", "why is Y empty" or "what should I do next". It is read-only and spends an AI credit; a direct read tool is cheaper when the data needed is already known. Takes one self-contained question.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| question* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"question"
],
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"question": {
"type": "string",
"maxLength": 2000,
"minLength": 1
}
},
"additionalProperties": false
}Creates a project — one more site or brand under the account — and returns its id. Pass that id as the project argument (or x-fnlowl-project / FNLOWL_PROJECT) to work inside it. Projects cannot be deleted from here.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| emoji | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"emoji": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Create a transactional template. category is one of authentication, account, orders, notifications. Use {{name}} placeholders in the subject and body for values supplied when it is sent; a placeholder nobody supplies is replaced with nothing. It creates the template only — sending needs a person.
| Argument | Type | Description |
|---|---|---|
| body* | string | |
| name* | string | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| subject* | string | |
| category* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"category",
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"subject": {
"type": "string",
"minLength": 1
},
"category": {
"enum": [
"authentication",
"account",
"orders",
"notifications"
],
"type": "string"
}
},
"additionalProperties": false
}Create a widget in the current project. Six kinds: lead-magnet, popup, survey, announcement-bar, quiz, calculator. It is always created as a draft, and the result lists `issues` — what is still missing before it could go live (empty when nothing is); fix them with update_widget. Going live is a separate step, request_widget_publish. What each kind needs (send only name and kind and the rest starts from sensible defaults): lead-magnet — headline, description, buttonText, contentUrl (a link to the file), optional questions; type "ai" personalises the delivery and needs at least one question. popup — headline, description, buttonText, plus trigger (immediate | exit-intent | scroll | time) with triggerValue (seconds for time, percent for scroll) and placement (center | bottom-right | bottom-left | top-right | top-left); a popup defaults to a time trigger of 8 seconds. For more than one condition, or a click/hover trigger, send triggers (an array of {type: immediate | exit-intent | scroll | time | click | hover, value, selector}; selector is a CSS selector on the host page, only meaningful for click/hover) with triggerMode "any" (the default — opens on the first one met) or "all" (waits for every one). startAt/endAt (epoch milliseconds) bound when a widget runs at all; leave both unset to run with no date limit. survey — questions, each {text, type: short | long | single | multi, options: [] (labels, only for single and multi)}; asks for an email afterwards only if requireEmail is true. quiz — quizQuestions [{text, options: [{label, score}]}] with at least two options each, and quizTiers [{minScore, maxScore, label, message}]; the visitor's total is the sum of the chosen options' scores, and the tiers must cover every possible total from the lowest to the highest with no gap. calculator — calcInputs [{label, min, max, step, default}] (integers), calcFormula using the inputs BY POSITION as a, b, c… with + - * / and brackets (e.g. "a * b * 12"), and calcOutputTemplate where {{result}} is replaced by the answer (e.g. "You could save ${{result}} a year"). announcement-bar — barMessage, barCtaText (the link label), barCtaUrl, barPosition (top | bottom). Popups and bars load sitewide from the one install snippet and can be kept off pages: hideOnValue lists URL pieces they never show on (e.g. "/checkout, /thank-you"), and showOn "url" with showOnValue limits them to pages whose URL contains one of the pieces; showOn "all" is every page. Style is optional and inherits the account's brand when omitted: theme, accentColor, backgroundColor, textColor (hex), cornerStyle, logoUrl.
Create a campaign AS A DRAFT. There is no tool that sends one: sending puts mail in thousands of real inboxes, spends deliverability reputation that cannot be bought back, and cannot be undone. A person sends it from the dashboard. recipientScope is "all" or a single widget id, and unsubscribed or bounced addresses are excluded automatically.
| Argument | Type | Description |
|---|---|---|
| body* | string | |
| name* | string | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| subject* | string | |
| recipientScope* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"subject",
"body",
"recipientScope"
],
"properties": {
"body": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"subject": {
"type": "string",
"minLength": 1
},
"recipientScope": {
"type": "string"
}
},
"additionalProperties": false
}Create a sequence AS A DRAFT. Steps are either an email or a delay in days — a delay is its own step, so two emails can run back to back. A branch may be added at the end; its paths are evaluated first-match-wins, left to right, and a filter with field null always matches, so it only makes sense last. Filters can only test what a lead already carries: unsubscribed and quizTierLabel.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| steps* | array | |
| branch* | any | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| widgetId* | string | null |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"widgetId",
"steps",
"branch"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"steps": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"type": {
"type": "string",
"const": "email"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"delayDays"
],
"properties": {
"type": {
"type": "string",
"const": "delay"
},
"delayDays": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"branch": {
"anyOf": [
{
"type": "object",
"required": [
"filters"
],
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"equals",
"steps"
],
"properties": {
"field": {
"anyOf": [
{
"enum": [
"unsubscribed",
"quizTierLabel"
],
"type": "string"
},
{
"type": "null"
}
]
},
"steps": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"type": {
"type": "string",
"const": "email"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"delayDays"
],
"properties": {
"type": {
"type": "string",
"const": "delay"
},
"delayDays": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"equals": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"widgetId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}Campaigns in this project, newest first, with their status. Open and click numbers come from the sent-email ledger, not from a counter on the campaign.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}List recent email outcomes for this account. Recipients are masked; use this to diagnose queued, delivered, opened, clicked, bounced, complained, or failed mail. `sentToday` counts the last 24 hours on a rolling basis, while `sharedTrial.sendsUsed` counts the account's lifetime sends on the shared trial, so the two legitimately differ. Does not send mail.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}List native integration providers and connection health. Credentials are never returned.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}Captured leads for the current project, newest first. PAGED — at most 200 per call, and the limit is a hard cap, not a default you can raise; pass offset for the next page (limit 50 with offset 50 returns leads 51 onward). These rows are real people's email addresses. Each lead carries a quality verdict (good, warn, bad, unchecked) from cheap capture-time checks; bad leads are stored but were never mailed, and quality filters the list.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| offset | integer | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| quality | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1
},
"offset": {
"type": "integer",
"minimum": 0
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"quality": {
"enum": [
"good",
"warn",
"bad",
"unchecked"
],
"type": "string"
}
},
"additionalProperties": false
}Lists the projects this credential can act on. A project is one site or brand under the account, and every widget, lead, campaign and sequence belongs to one. Pass an id as the project argument on any tool to run that call in it, or as the x-fnlowl-project header (remote) or FNLOWL_PROJECT (local) to set the connection's default; with neither, tools read across the whole account. The row with current true is the one this call was already scoped to; no row is current when the reads cover the whole account.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
}Who is running through which sequence: for a lead (leadId) or for a sequence (sequenceId), each enrolment's status (active, finished or stopped), the step it is on and when it is next due. This is how to answer "why did this lead get, or not get, the follow-up" — a lead with no enrolment was never enrolled, and activating a sequence enrols future leads, not past ones. At most 100 rows, oldest first.
| Argument | Type | Description |
|---|---|---|
| leadId | string | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| sequenceId | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"leadId": {
"type": "string",
"minLength": 1
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"sequenceId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Sequences in this project with their steps and branch. The shape is BOUNDED: a linear chain of steps, then at most one branch point, each path its own linear chain. No nesting, no rejoining, no parallel paths.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}Transactional templates in this account. Built-in starters are marked isCustom false and cannot be deleted.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}The same numbers per widget, best-converting first. Use this to answer which magnet is working; use widget_results for where one widget's traffic came from.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}Every widget in the current project, newest last. Returns summaries only — id, name, kind, type, status, article, views, completions. Use read_widget for one widget's full content.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}Presents the user with a choice between 2 to 4 options, each with a label and a one-line description, one optionally marked recommended. It is for decisions where reasonable options would build different things — which widget kind, what score ranges, what copy or trigger — and nothing the user said settles it. It changes nothing and returns the options for the user to answer.
| Argument | Type | Description |
|---|---|---|
| options* | array | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| question* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"question",
"options"
],
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"description"
],
"properties": {
"label": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string",
"minLength": 1
},
"recommended": {
"type": "boolean"
}
},
"additionalProperties": false
},
"maxItems": 4,
"minItems": 2
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"question": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Move a sequence to draft, which stops new enrolments. Stopping mail is never the slower path, so this applies immediately. Starting one again is activate_sequence: an active sequence enrols every future lead and sends on a timer with nobody watching.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| sequenceId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sequenceId"
],
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"sequenceId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Gives an agent what it needs to advise on a website's lead capture: a snapshot of the website's widgets (kind, live or draft, views, completions, conversion), the six widget kinds with where each appears, and the steps to follow — read the site, ask the user questions with offer_choice, then rank 3-5 fixes. It fetches no pages and changes nothing. Suited to "what should I do on my site" or "audit my site". Scoped to the current website; pass `project` to pick another.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}The account's AI context: what the blog is about, its pricing tiers, value props, testimonials, design direction and tone presets. Every AI-personalised lead magnet is generated from exactly this plus the visitor's own answers. It belongs to the whole account and is shared by every website on it, so a connection limited to one website can read it but not change it.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}Read recent AI lead-magnet generation outcomes by status and widget. Visitor answers, generated content, lead ids, and failure details are not returned.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}Totals for the current project: widget count, page views, completions, conversion percentage, lead count and how many have unsubscribed. Conversion is completions divided by views as a whole percentage; with no views yet it reads 0, which means NO DATA rather than a failure. Completions is not leads — an announcement-bar or an ungated calculator completes without capturing an address. Pass from and to (epoch milliseconds, both) for a date range: the response then also carries that window and the same-length window before it (views, leads, conversions, revenue in cents), plus leads by device and by UTM source. Leads marked bad are excluded from those figures.
| Argument | Type | Description |
|---|---|---|
| to | integer | |
| from | integer | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"to": {
"type": "integer"
},
"from": {
"type": "integer"
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}The brand: site name, accent colour, sender name, logo and the postal address that every commercial email needs in its footer. With a project in scope this is that website's brand — the account defaults with the website's own overrides applied; without one it is the account defaults.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}The A/B experiment a widget is in (or last ran as control): per arm, assigned views, leads, conversion rate and 95% interval in basis points (1234 = 12.34%), and lift against the control arm. result "insufficient_data" means at least one arm has too few views for a rate to mean anything; in that case NO rate or lift is given for any arm, so none is available. A running experiment lists every arm, including one with no views yet. The "holdout" arm sees no widget, so it shows exposure only. beatsControlBp is the chance (in basis points) that a variant beats the control. verdict.status is collecting, leaning or winner, with a leader arm and a plain-language note; it informs a decision and never stops or publishes anything. Views are page loads, so repeat visitors count more than once and the odds are directional.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| widgetId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"widgetId"
],
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"widgetId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Read recent queued ESP/webhook handoff outcomes and retry state. Lead identifiers, payloads, and credentials are not returned.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}One lead with the answers it gave, and its quiz score and tier if it came from a quiz. The score is frozen at the moment of submission — it is what that visitor actually saw, not a recomputation against the quiz as it stands today.
| Argument | Type | Description |
|---|---|---|
| leadId* | string | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"leadId"
],
"properties": {
"leadId": {
"type": "string",
"minLength": 1
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}Reads the account's plan and what it has used of each monthly quota: leads captured, emails sent, AI messages, plus how many websites and widgets exist against the plan's limits. Leads are counted over the billing period and everything else over the calendar month (UTC). `plan` is null when no plan is active. Answers "what is my limit" and "how close am I to the cap". Changes nothing.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
}Read account sending readiness, domain verification, daily usage, and recent reputation state. While the sending domain is not yet verified it also returns `records`: the DNS records to publish. `sentToday` counts the last 24 hours on a rolling basis, while `sharedTrial.sendsUsed` counts the account's lifetime sends on the shared trial, so the two legitimately differ. Does not send mail.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
}
},
"additionalProperties": false
}One widget in full, plus `issues` — what is still missing before it could go live. Includes its questions, quiz questions and options, quiz tiers and calculator inputs. Which of those are meaningful depends on the kind: questions for lead-magnet and survey, quiz fields for quiz, calculator inputs for calculator, none for popup and announcement-bar. `placement` says where it shows on a site: popups and bars run on every page, every other kind only where a page embeds it — going live alone does not place it on any page.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| widgetId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"widgetId"
],
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"widgetId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}One widget's views, completions, conversion, and its leads grouped by referrer. The referrer is whatever the visitor's browser reported when they submitted, so it is a rough attribution, not a tracked source. Also returns the funnel (views, completions, leads, conversions, revenue in cents; conversions are purchases credited to a lead within 14 days of capture), questionDropoff (how many visitors left a survey on each question, in question order) and the same optional from/to date range as read_analytics.
| Argument | Type | Description |
|---|---|---|
| to | integer | |
| from | integer | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| widgetId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"widgetId"
],
"properties": {
"to": {
"type": "integer"
},
"from": {
"type": "integer"
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"widgetId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Ask for a draft widget to go live. This requests publication; it does not publish. Called over the API or MCP with a key it does NOT publish: it creates a pending approval carrying a before/after snapshot and returns it, and the widget goes live only when a signed-in person approves it in the dashboard. The result also says where the widget will appear (`placement` — going live does not put a quiz, survey, calculator or lead magnet on any page by itself) and lists `warnings`, such as copy that promises an email no active sequence will send.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| widgetId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"widgetId"
],
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"widgetId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Split traffic between a control widget and 1 to 3 variants. The variants must already exist as their own live widgets, of the same kind and project as the control (created with create_widget and made live with request_widget_publish). On a small site one variant at a time is the practical limit: every extra arm needs the same traffic again. Traffic splits evenly unless trafficPcts is given: one whole-number percentage per arm, the control first and then each variant in the order listed, which together with holdoutPct must add up to 100. holdoutPct (0 to 50, default 0) is an optional share that sees no widget; it can never produce a lead, so it shows exposure only and does NOT measure lift. read_experiment_results reports views, leads, rate and lift per arm, plus a verdict, once it is running.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| widgetId* | string | |
| holdoutPct | integer | |
| trafficPcts | array | |
| variantWidgetIds* | array |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"widgetId",
"variantWidgetIds"
],
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"widgetId": {
"type": "string",
"minLength": 1
},
"holdoutPct": {
"type": "integer",
"maximum": 50,
"minimum": 0
},
"trafficPcts": {
"type": "array",
"items": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"maxItems": 4,
"minItems": 2
},
"variantWidgetIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 3,
"minItems": 1
}
},
"additionalProperties": false
}End a running experiment. Counts stop with it; starting a new one on the same widgets begins with fresh counts, not a resume.
| Argument | Type | Description |
|---|---|---|
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| widgetId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"widgetId"
],
"properties": {
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"widgetId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Change the AI context. This is the highest-leverage thing you can write here: it is tedious for a person to fill in and it improves every generation afterwards. Only the fields sent are changed. It holds what the site actually says, so testimonials and prices come from the owner. The AI context belongs to the whole account and is shared by every website on it, so it cannot be changed from a connection limited to one website.
| Argument | Type | Description |
|---|---|---|
| about | string | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| valueProps | array | |
| pricingTiers | array | |
| testimonials | array | |
| designDirection | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"about": {
"type": "string"
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"valueProps": {
"type": "array",
"items": {
"type": "string"
}
},
"pricingTiers": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"price",
"description"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"price": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
},
"testimonials": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"quote",
"author"
],
"properties": {
"id": {
"type": "string"
},
"quote": {
"type": "string"
},
"author": {
"type": "string"
}
},
"additionalProperties": false
}
},
"designDirection": {
"type": "string"
}
},
"additionalProperties": false
}Change brand settings. Only the fields sent are changed. With a project in scope this sets that website's own override and leaves the account defaults — and every other website — alone; without one it changes the account defaults every website inherits. The accent colour must be a hex value — it is interpolated into a stylesheet that renders on customers' websites.
| Argument | Type | Description |
|---|---|---|
| logoUrl | string | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| siteName | string | |
| termsUrl | string | |
| legalName | string | |
| privacyUrl | string | |
| senderName | string | |
| accentColor | string | |
| mailingAddress | string |
Change a draft campaign. A campaign that has already been sent cannot be edited — the ledger describes what actually went out, and editing it afterwards would make that a lie.
| Argument | Type | Description |
|---|---|---|
| body | string | |
| name | string | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| subject | string | |
| campaignId* | string | |
| recipientScope | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaignId"
],
"properties": {
"body": {
"type": "string"
},
"name": {
"type": "string"
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"subject": {
"type": "string"
},
"campaignId": {
"type": "string",
"minLength": 1
},
"recipientScope": {
"type": "string"
}
},
"additionalProperties": false
}Change a DRAFT sequence. Only the fields sent are changed, except that sending steps or branch replaces the whole of that part, so send the complete chain you want. It cannot edit an active sequence and cannot activate one: an active sequence is paused with pause_sequence, edited, and started again with activate_sequence. Enrolments already running keep the plan they started with.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| steps | array | |
| branch | any | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| widgetId | string | null | |
| sequenceId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sequenceId"
],
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"steps": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"type": {
"type": "string",
"const": "email"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"delayDays"
],
"properties": {
"type": {
"type": "string",
"const": "delay"
},
"delayDays": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"branch": {
"anyOf": [
{
"type": "object",
"required": [
"filters"
],
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"equals",
"steps"
],
"properties": {
"field": {
"anyOf": [
{
"enum": [
"unsubscribed",
"quizTierLabel"
],
"type": "string"
},
{
"type": "null"
}
]
},
"steps": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"type": {
"type": "string",
"const": "email"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"delayDays"
],
"properties": {
"type": {
"type": "string",
"const": "delay"
},
"delayDays": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"equals": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"widgetId": {
"type": [
"string",
"null"
]
},
"sequenceId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Change a template's name, category, subject or body — only the fields sent. Built-in starters can be rewritten too (they just cannot be deleted). It changes what later sends of this template say; it sends nothing.
| Argument | Type | Description |
|---|---|---|
| body | string | |
| name | string | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| subject | string | |
| category | string | |
| templateId* | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"templateId"
],
"properties": {
"body": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"subject": {
"type": "string",
"minLength": 1
},
"category": {
"enum": [
"authentication",
"account",
"orders",
"notifications"
],
"type": "string"
},
"templateId": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Change a widget. Only the fields sent are changed, with one exception: sending ANY of questions, quizQuestions, quizTiers or calcInputs replaces ALL FOUR with exactly what is sent, so send the complete set you want to end up with. Publishing is a separate action. Views and completions cannot be set — they are counted from real traffic. The result lists `issues` — what is still missing before it could go live. What each kind needs (send only name and kind and the rest starts from sensible defaults): lead-magnet — headline, description, buttonText, contentUrl (a link to the file), optional questions; type "ai" personalises the delivery and needs at least one question. popup — headline, description, buttonText, plus trigger (immediate | exit-intent | scroll | time) with triggerValue (seconds for time, percent for scroll) and placement (center | bottom-right | bottom-left | top-right | top-left); a popup defaults to a time trigger of 8 seconds. For more than one condition, or a click/hover trigger, send triggers (an array of {type: immediate | exit-intent | scroll | time | click | hover, value, selector}; selector is a CSS selector on the host page, only meaningful for click/hover) with triggerMode "any" (the default — opens on the first one met) or "all" (waits for every one). startAt/endAt (epoch milliseconds) bound when a widget runs at all; leave both unset to run with no date limit. survey — questions, each {text, type: short | long | single | multi, options: [] (labels, only for single and multi)}; asks for an email afterwards only if requireEmail is true. quiz — quizQuestions [{text, options: [{label, score}]}] with at least two options each, and quizTiers [{minScore, maxScore, label, message}]; the visitor's total is the sum of the chosen options' scores, and the tiers must cover every possible total from the lowest to the highest with no gap. calculator — calcInputs [{label, min, max, step, default}] (integers), calcFormula using the inputs BY POSITION as a, b, c… with + - * / and brackets (e.g. "a * b * 12"), and calcOutputTemplate where {{result}} is replaced by the answer (e.g. "You could save ${{result}} a year"). announcement-bar — barMessage, barCtaText (the link label), barCtaUrl, barPosition (top | bottom). Popups and bars load sitewide from the one install snippet and can be kept off pages: hideOnValue lists URL pieces they never show on (e.g. "/checkout, /thank-you"), and showOn "url" with showOnValue limits them to pages whose URL contains one of the pieces; showOn "all" is every page. Style is optional and inherits the account's brand when omitted: theme, accentColor, backgroundColor, textColor (hex), cornerStyle, logoUrl.
| Argument | Type | Description |
|---|---|---|
| kind* | string | |
| name* | string | |
| type | string | |
| endAt | any | |
| theme | any | |
| layout | string | |
| showOn | string | |
| article | string | |
| logoUrl | string | null | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| startAt | any | |
| subject | string | |
| trigger | string | |
| headline | string | |
| position | string | |
| triggers | array | |
| barCtaUrl | string | |
| emailBody | string | |
| firstStep | string | |
| placement | any | |
| questions | array | |
| quizTiers | array | |
| textColor | any | |
| barCtaText | string | |
| barMessage | string | |
| buttonText | string | |
| calcInputs | array | |
| contentUrl | string | |
| popupWidth | any | |
| rewardCode | string | null | |
| rewardType | string | |
| senderName | string | |
| accentColor | any | |
| barPosition | any | |
| buttonStyle | string | |
| calcFormula | string | |
| consentText | string | |
| cornerStyle | any | |
| description | string | |
| emailFormat | string | |
| hideOnValue | string | |
| showOnValue | string | |
| triggerMode | string | |
| cooldownDays | any | |
| hookQuestion | string | null | |
| requireEmail | boolean | |
| triggerValue | integer | |
| audienceRules | array | |
| maxDismissals | any | |
| quizQuestions | array | |
| rewardPercent | any | |
| wheelSegments | array | |
| floatingButton | any | |
| questionRoutes | array | |
| successMessage | string | |
| backgroundColor | any | |
| successHeadline | string | |
| calcOutputTemplate | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"kind"
],
"properties": {
"kind": {
"enum": [
"lead-magnet",
"popup",
"survey",
"announcement-bar",
"quiz",
"calculator"
],
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"type": {
"enum": [
"static",
"ai"
],
"type": "string"
},
"endAt": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"theme": {
"anyOf": [
{
"enum": [
"light",
"dark"
],
"type": "string"
},
{
"type": "null"
}
]
},
"layout": {
"enum": [
"simple",
"visual"
],
"type": "string"
},
"showOn": {
"type": "string"
},
"article": {
"type": "string"
},
"logoUrl": {
"type": [
"string",
"null"
]
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"startAt": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"subject": {
"type": "string"
},
"trigger": {
"enum": [
"immediate",
"exit-intent",
"scroll",
"time"
],
"type": "string"
},
"headline": {
"type": "string"
},
"position": {
"enum": [
"intro",
"middle",
"end"
],
"type": "string"
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"value",
"selector"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"immediate",
"exit-intent",
"scroll",
"time",
"click",
"hover"
],
"type": "string"
},
"value": {
"type": "integer"
},
"selector": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"barCtaUrl": {
"type": "string"
},
"emailBody": {
"type": "string"
},
"firstStep": {
"enum": [
"none",
"micro-commitment",
"spin-to-win"
],
"type": "string"
},
"placement": {
"anyOf": [
{
"enum": [
"center",
"bottom-right",
"bottom-left",
"top-right",
"top-left"
],
"type": "string"
},
{
"type": "null"
}
]
},
"questions": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"type",
"options"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"short",
"long",
"single",
"multi"
],
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"quizTiers": {
"type": "array",
"items": {
"type": "object",
"required": [
"minScore",
"maxScore",
"label",
"message"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"message": {
"type": "string"
},
"maxScore": {
"type": "integer"
},
"minScore": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"textColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{3,8}$"
},
{
"type": "null"
}
]
},
"barCtaText": {
"type": "string"
},
"barMessage": {
"type": "string"
},
"buttonText": {
"type": "string"
},
"calcInputs": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"min",
"max",
"step",
"default"
],
"properties": {
"id": {
"type": "string"
},
"max": {
"type": "integer"
},
"min": {
"type": "integer"
},
"step": {
"type": "integer"
},
"label": {
"type": "string"
},
"default": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"contentUrl": {
"type": "string"
},
"popupWidth": {
"anyOf": [
{
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
{
"type": "null"
}
]
},
"rewardCode": {
"type": [
"string",
"null"
]
},
"rewardType": {
"enum": [
"none",
"static",
"unique"
],
"type": "string"
},
"senderName": {
"type": "string"
},
"accentColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{3,8}$"
},
{
"type": "null"
}
]
},
"barPosition": {
"anyOf": [
{
"enum": [
"top",
"bottom",
"top-left",
"top-right",
"bottom-left",
"bottom-right"
],
"type": "string"
},
{
"type": "null"
}
]
},
"buttonStyle": {
"enum": [
"filled",
"outline",
"rounded"
],
"type": "string"
},
"calcFormula": {
"type": "string"
},
"consentText": {
"type": "string"
},
"cornerStyle": {
"anyOf": [
{
"enum": [
"sharp",
"soft",
"round"
],
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"emailFormat": {
"enum": [
"branded",
"minimal"
],
"type": "string"
},
"hideOnValue": {
"type": "string"
},
"showOnValue": {
"type": "string"
},
"triggerMode": {
"enum": [
"any",
"all"
],
"type": "string"
},
"cooldownDays": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"hookQuestion": {
"type": [
"string",
"null"
]
},
"requireEmail": {
"type": "boolean"
},
"triggerValue": {
"type": "integer"
},
"audienceRules": {
"type": "array",
"items": {
"type": "object",
"required": [
"facet",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"facet": {
"enum": [
"source",
"device",
"visitor"
],
"type": "string"
},
"value": {
"type": "string"
},
"operator": {
"enum": [
"is",
"is_not"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"maxDismissals": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"quizQuestions": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"options"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"score"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"score": {
"type": "integer"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"rewardPercent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"wheelSegments": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"rewardCode"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"rewardCode": {
"type": "string"
}
},
"additionalProperties": false
}
},
"floatingButton": {
"anyOf": [
{
"enum": [
"bottom-left",
"bottom-right",
"left",
"right"
],
"type": "string"
},
{
"type": "null"
}
]
},
"questionRoutes": {
"type": "array",
"items": {
"type": "object",
"required": [
"questionId",
"whenOption",
"gotoQuestionId"
],
"properties": {
"id": {
"type": "string"
},
"questionId": {
"type": "string"
},
"whenOption": {
"type": "string"
},
"gotoQuestionId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"successMessage": {
"type": "string"
},
"backgroundColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{3,8}$"
},
{
"type": "null"
}
]
},
"successHeadline": {
"type": "string"
},
"calcOutputTemplate": {
"type": "string"
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"logoUrl": {
"type": "string"
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"siteName": {
"type": "string"
},
"termsUrl": {
"type": "string"
},
"legalName": {
"type": "string"
},
"privacyUrl": {
"type": "string"
},
"senderName": {
"type": "string"
},
"accentColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{3,8}$"
},
"mailingAddress": {
"type": "string"
}
},
"additionalProperties": false
}| Argument | Type | Description |
|---|---|---|
| kind | string | |
| name | string | |
| type | string | |
| endAt | any | |
| theme | any | |
| layout | string | |
| showOn | string | |
| article | string | |
| logoUrl | string | null | |
| project | string | A project id from list_projects. Runs this call in that project instead of the connection default. |
| startAt | any | |
| subject | string | |
| trigger | string | |
| headline | string | |
| position | string | |
| triggers | array | |
| widgetId* | string | |
| barCtaUrl | string | |
| emailBody | string | |
| firstStep | string | |
| placement | any | |
| questions | array | |
| quizTiers | array | |
| textColor | any | |
| barCtaText | string | |
| barMessage | string | |
| buttonText | string | |
| calcInputs | array | |
| contentUrl | string | |
| popupWidth | any | |
| rewardCode | string | null | |
| rewardType | string | |
| senderName | string | |
| accentColor | any | |
| barPosition | any | |
| buttonStyle | string | |
| calcFormula | string | |
| consentText | string | |
| cornerStyle | any | |
| description | string | |
| emailFormat | string | |
| hideOnValue | string | |
| showOnValue | string | |
| triggerMode | string | |
| cooldownDays | any | |
| hookQuestion | string | null | |
| requireEmail | boolean | |
| triggerValue | integer | |
| audienceRules | array | |
| maxDismissals | any | |
| quizQuestions | array | |
| rewardPercent | any | |
| wheelSegments | array | |
| floatingButton | any | |
| questionRoutes | array | |
| successMessage | string | |
| backgroundColor | any | |
| successHeadline | string | |
| calcOutputTemplate | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"widgetId"
],
"properties": {
"kind": {
"enum": [
"lead-magnet",
"popup",
"survey",
"announcement-bar",
"quiz",
"calculator"
],
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"type": {
"enum": [
"static",
"ai"
],
"type": "string"
},
"endAt": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"theme": {
"anyOf": [
{
"enum": [
"light",
"dark"
],
"type": "string"
},
{
"type": "null"
}
]
},
"layout": {
"enum": [
"simple",
"visual"
],
"type": "string"
},
"showOn": {
"type": "string"
},
"article": {
"type": "string"
},
"logoUrl": {
"type": [
"string",
"null"
]
},
"project": {
"type": "string",
"description": "A project id from list_projects. Runs this call in that project instead of the connection default."
},
"startAt": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"subject": {
"type": "string"
},
"trigger": {
"enum": [
"immediate",
"exit-intent",
"scroll",
"time"
],
"type": "string"
},
"headline": {
"type": "string"
},
"position": {
"enum": [
"intro",
"middle",
"end"
],
"type": "string"
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"value",
"selector"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"immediate",
"exit-intent",
"scroll",
"time",
"click",
"hover"
],
"type": "string"
},
"value": {
"type": "integer"
},
"selector": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"widgetId": {
"type": "string",
"minLength": 1
},
"barCtaUrl": {
"type": "string"
},
"emailBody": {
"type": "string"
},
"firstStep": {
"enum": [
"none",
"micro-commitment",
"spin-to-win"
],
"type": "string"
},
"placement": {
"anyOf": [
{
"enum": [
"center",
"bottom-right",
"bottom-left",
"top-right",
"top-left"
],
"type": "string"
},
{
"type": "null"
}
]
},
"questions": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"type",
"options"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"type": {
"enum": [
"short",
"long",
"single",
"multi"
],
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"quizTiers": {
"type": "array",
"items": {
"type": "object",
"required": [
"minScore",
"maxScore",
"label",
"message"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"message": {
"type": "string"
},
"maxScore": {
"type": "integer"
},
"minScore": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"textColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{3,8}$"
},
{
"type": "null"
}
]
},
"barCtaText": {
"type": "string"
},
"barMessage": {
"type": "string"
},
"buttonText": {
"type": "string"
},
"calcInputs": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"min",
"max",
"step",
"default"
],
"properties": {
"id": {
"type": "string"
},
"max": {
"type": "integer"
},
"min": {
"type": "integer"
},
"step": {
"type": "integer"
},
"label": {
"type": "string"
},
"default": {
"type": "integer"
}
},
"additionalProperties": false
}
},
"contentUrl": {
"type": "string"
},
"popupWidth": {
"anyOf": [
{
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
{
"type": "null"
}
]
},
"rewardCode": {
"type": [
"string",
"null"
]
},
"rewardType": {
"enum": [
"none",
"static",
"unique"
],
"type": "string"
},
"senderName": {
"type": "string"
},
"accentColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{3,8}$"
},
{
"type": "null"
}
]
},
"barPosition": {
"anyOf": [
{
"enum": [
"top",
"bottom",
"top-left",
"top-right",
"bottom-left",
"bottom-right"
],
"type": "string"
},
{
"type": "null"
}
]
},
"buttonStyle": {
"enum": [
"filled",
"outline",
"rounded"
],
"type": "string"
},
"calcFormula": {
"type": "string"
},
"consentText": {
"type": "string"
},
"cornerStyle": {
"anyOf": [
{
"enum": [
"sharp",
"soft",
"round"
],
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"emailFormat": {
"enum": [
"branded",
"minimal"
],
"type": "string"
},
"hideOnValue": {
"type": "string"
},
"showOnValue": {
"type": "string"
},
"triggerMode": {
"enum": [
"any",
"all"
],
"type": "string"
},
"cooldownDays": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"hookQuestion": {
"type": [
"string",
"null"
]
},
"requireEmail": {
"type": "boolean"
},
"triggerValue": {
"type": "integer"
},
"audienceRules": {
"type": "array",
"items": {
"type": "object",
"required": [
"facet",
"operator",
"value"
],
"properties": {
"id": {
"type": "string"
},
"facet": {
"enum": [
"source",
"device",
"visitor"
],
"type": "string"
},
"value": {
"type": "string"
},
"operator": {
"enum": [
"is",
"is_not"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"maxDismissals": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"quizQuestions": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"options"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"score"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"score": {
"type": "integer"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"rewardPercent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"wheelSegments": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"rewardCode"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"rewardCode": {
"type": "string"
}
},
"additionalProperties": false
}
},
"floatingButton": {
"anyOf": [
{
"enum": [
"bottom-left",
"bottom-right",
"left",
"right"
],
"type": "string"
},
{
"type": "null"
}
]
},
"questionRoutes": {
"type": "array",
"items": {
"type": "object",
"required": [
"questionId",
"whenOption",
"gotoQuestionId"
],
"properties": {
"id": {
"type": "string"
},
"questionId": {
"type": "string"
},
"whenOption": {
"type": "string"
},
"gotoQuestionId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"successMessage": {
"type": "string"
},
"backgroundColor": {
"anyOf": [
{
"type": "string",
"pattern": "^#[0-9a-fA-F]{3,8}$"
},
{
"type": "null"
}
]
},
"successHeadline": {
"type": "string"
},
"calcOutputTemplate": {
"type": "string"
}
},
"additionalProperties": false
}