Skip to content

Popular

  • Embed not showing on my website
  • Connect Claude or ChatGPT (MCP)
  • Set up a custom domain
  • Order a build through Lumina
  • What Lumina Assistant can do

↑ ↓ to move · Enter to open · Esc to close

Developers

Agency REST API

Manage your agency from your own software. The API runs the same account operations as the dashboard.

Base URL: https://luminasales.io/api/v1. Download the OpenAPI specification or check service status.

Authentication

Sign in to Lumina Sales and open Developers to create a scoped access token. Copy the secret when it is issued—it is shown once—then send it in the Authorization header. Set an expiry and revoke the token from Developers when the integration no longer needs access.

export LUMINA_URL="https://luminasales.io"

curl "$LUMINA_URL/api/v1/agency" \
  -H "Authorization: Bearer $LUMINA_ACCESS_TOKEN"

Use the public API origin shown above for LUMINA_URL. Durable tokens begin with lsk_live_, are stored only as SHA-256 hashes, and stay bound to the agency and issuing member. Lumina checks their scope, expiry, revocation state, membership, and user state on every request. The optional X-Lumina-Agency-Id header may assert the same agency; a different ID is rejected. Signed-in dashboard clients may continue using short-lived Supabase user access tokens and can select a membership with that header.

A token holds one or more scopes. api:read covers every GET outside Blogs and never authorizes a change. api:write covers every POST, PUT, PATCH, and DELETE outside Blogs: the request runs as the member who created the token, with that member's permissions and the same database rules as their dashboard session. Blogs has its own blogs:read, blogs:write, and blogs:generate. A request whose scope the token lacks returns 403 insufficient_scope.

A few actions stay with the owner in the dashboard and return 403 owner_action_required for every token, whatever its scopes: changes to the team, the billing portal, notification settings, account deletion, renaming the subdomain, removing a domain, changing the referral code, resuming billing on a build, the Lumina Assistant, buying a demo slot (confirmSlots above zero), and deleting a client or project with acknowledge_billing. Each of them either gives someone else access, moves money, or cannot be undone by revoking the token. Every change a token makes is recorded against it.

Cookie authentication is available to the dashboard; cookie-authenticated writes require a matching Origin header. Cross-origin browser clients can use bearer tokens. CORS does not allow cross-origin cookies. Never place tokens in URLs or frontend source code.

Requests and responses

Send JSON with Content-Type: application/json. Bodies are limited to 1 MiB except the documented file-upload operations. Unknown fields are rejected. PATCH updates only supplied fields; null clears a nullable field. PUT replaces the documented fields. Empty-body operations also accept an omitted body. Lists use limit, from 1 to 100, and offset, starting at zero. The default limit is 25. Paginated records sort newest first with an ID tie-breaker. Requests are limited to 120 per minute per agency member.

{
  "data": {
    "items": [],
    "total": 0,
    "limit": 25,
    "offset": 0
  },
  "request_id": "b80a855d-1c55-4bf7-a789-65b7f5ab47e4"
}

Errors contain error.code, error.message, and request_id. Validation errors also identify fields in error.details. Save X-Request-Id when reporting a failed request. Honor Retry-After on a 429 response. A 401 means the token is invalid, expired, or revoked; 403 means its scope or the member lacks permission; 404 means the resource is not accessible in the current agency; 422 means input or a workflow condition was rejected.

A 402 requires a subscription. A 409 can indicate incomplete account setup, a protected workflow, an additional-slot purchase that needs confirmation, or a duplicate request with conflicting input. A 503 means a required dependency or database migration is unavailable. The API returns no-store headers for agency responses.

MCP server

The same operations are available to AI agents as tools at https://luminasales.io/api/mcp. It speaks stateless Streamable HTTP, takes the same lsk_live_ token in the Authorization header, and sends every tool call through this API, so scopes, permissions, rate limits, and idempotent retries behave exactly as documented here. Each operation in the reference below is one tool, named by its operation ID; lumina_get_context describes the connection. Add ?mode=compact for four tools (search, describe, call, and context) when a client limits how many tools a server may list, or ?toolsets=clients,demos to expose only some areas. Setup snippets for common agents are on the Developers page.

Safe retries

For JSON POST operations, send Idempotency-Key with a unique value of 8 to 200 printable ASCII characters. Keep the same key, path, and JSON body when retrying. For 24 hours, a completed request replays its original response and request ID with Idempotency-Replayed: true. A key reused with changed input returns 409. A request still running, or one whose outcome could not be saved, also returns 409. Read the resource and reconcile its state before using a new key. Assistant streams use messageId and turnToken instead.

Create a client

curl "$LUMINA_URL/api/v1/clients" \
  -H "Authorization: Bearer $LUMINA_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: client-import-2026-001' \
  -d '{"business_name":"Acme Plumbing","contact_name":"Alex","email":"alex@example.com"}'

The response contains data.result.id for the client. Keep that ID for subsequent requests. Client creation also prepares its onboarding form and portal. Portal and intake URLs are access credentials and appear only in operations requiring manage permission. File and contract downloads use expiring links.

Landing pages

A lander is a video sales page with a pre-qualification form and a booking step, served on the agency's own host. POST /landers with a name and the facts the copy is written from. Then POST to its generations resource once per phase: page, then funnel, then thankYou. Each phase spends one Lumina AI credit, writes its slice, and returns the phase to run next; keep going until next is null. A 402 means the monthly meter is spent, and a 429 means the shared generation rate limit was hit.

curl "$LUMINA_URL/api/v1/landers/$LANDER_ID/generations" \
  -H "Authorization: Bearer $LUMINA_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"scope":"page"}'

GET /landers returns each page with its document, facts, and scripts already parsed, so the response schema is the document contract rather than an opaque JSON blob. PUT /landers/{lander_id} replaces the whole document: read it, change it, and send it back. Publication is separate — POST the publications resource to go live and DELETE the publication resource to take it offline. Publishing needs a claimed subdomain, a booking link, a headline, a button label, and a free live slot on the plan; non-blocking findings come back in warnings.

Applications land in /lander-leads with their answers, score, and whether they qualified and booked. Those reads need clients:view as well as dashboards:view, because a lead carries a phone number and what the person typed. POST a lead's conversions resource to add them to the client roster. GET /landers/{lander_id}/analytics returns the funnel over a 1, 7, or 30 day window. All of it requires the deployment to have landing pages enabled; when it does not, writes return 503.

Blogs

Save the niche, audience, offer, proof, voice, keywords, and editorial rules once in the Blogs dashboard. POST /blogs/generate then creates one complete, brand-trained article and spends one Lumina AI credit after a successful result. Always send an Idempotency-Key when an automation may retry.

curl "$LUMINA_URL/api/v1/blogs/generate" \
  -H "Authorization: Bearer $LUMINA_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: weekly-pipeline-2026-09-10' \
  -d '{"topic":"How to repair a stalled sales pipeline","contentType":"how_to","targetWordCount":1200}'

GET /blogs lists the library, GET /blogs/{blog_id} returns the editable Markdown and SEO fields, and the export endpoint downloads Markdown or DOCX. Scoped tokens can separately allow read, edit, and generation access. The HTTP MCP server is available at /api/blogs/mcp and uses the same durable bearer tokens and rate limit. Scheduled generation and signed webhooks are configured in the Blogs dashboard.

Fulfillment pricing calls

Every fulfillment order is priced on a 30-minute call. The catalog and quotes return price guides in whole dollars: a setup, a monthly, and a per-minute rate on voice lines. POST /fulfillment/orders always creates a draft and returns requires_booking: true. POST its booking-sessions resource and book through the returned URL without removing its tracking parameters. Calendly's scheduled-event callback provides the event and invitee URIs; take their final path segments and POST event_id and invitee_id to booking-verifications. The server checks Calendly before saving the booking and sending the order. A boolean claim that a meeting was booked is never accepted.

In the dashboard, Continue to book your pricing call opens Calendly inside app.luminasales.io. A completed booking is verified and the order is sent automatically before returning to the client page. When the deployment has the Calendly webhook configured, a booking made through an order's link also sends the order on its own, so an interrupted browser loses nothing. After the call, Lumina locks the final setup, monthly, and per-minute price on each line.

GET the order's booking resource for current provider state and attendee-specific cancellation and rescheduling links. A rescheduled call is followed to its new time. Canceling the call puts an order that has not been accepted back to draft until a new time is booked; it never cancels billing. Calendar verification requires the deployment's Calendly integration. The API reports unavailable integration state explicitly.

Lumina Assistant

GET /assistant/tools for the tools allowed by your permissions. POST /assistant/turns with a new UUID messageId and a transcript beginning with a user message. Read the SSE data events. Keep the token from the turn event. When tool_calls arrives, POST each call to /assistant/tool-executions, append the assistant calls and tool results to the transcript, then request another step with the same messageId and turnToken. Stop on done when there are no tool calls, or handle the error event. A successful HTTP response can still contain a streamed error.

A tool can return needs_confirmation with a summary, warnings, and a signed confirmation ID. Review that operation before resubmitting identical arguments with confirmationId. Use /assistant/undos to preview and restore reversible changes. Browser draft tools are excluded from API model calls; use the demo, embed, and form REST resources to edit saved content.

Status and compatibility

GET /api/status returns current dependency checks. GET /api/status/history returns the last 24 hours of scheduled samples, per-component counts, and monitoring gaps. Scheduled checks run every five minutes and retain 30 days of records. Missing samples mean unknown availability. The status page runs on the application deployment; external monitoring should also check it for a complete deployment outage.

The version is in the /api/v1 path. Clients should tolerate new response fields and enum values while sending only documented request fields. Server-managed records such as usage, billing results, and fulfillment operator decisions are readable; they cannot be rewritten to override metering, charges, or work status.

Changelog

Speech-to-speech voice agents

  • Every voice agent now runs on an AI voice model with no separate text-to-speech voice. The default is Grok Voice 3.0 (speech-to-speech) with the Aurora voice. The other choice is GPT Live 1, a live voice model that hands lookups and bookings to a text model behind it.
  • PATCH /custom-niches/{niche_id} takes agent.voiceModel: grok-voice-3.0 (the default) or gpt-live-1. A model change without agent.voiceId goes to the new model's default voice.
  • agent.voiceId must be a voice of the niche's model. Another model's voice is refused with a message naming the model.
  • GET /voices lists only voices a model on offer speaks in, and each item has a model. Custom niche reads return voice_model.
  • Voices saved before this change that no model speaks in (Cartesia, ElevenLabs, Retell platform voices) were dropped, so those niches use the model's default voice.

Custom niches, demos made for one business, and client branding

  • New Custom niches resource: GET and POST /custom-niches, GET, PATCH and DELETE /custom-niches/{niche_id}, and POST to its drafts (refill from a website or a description), agents (update the voice and chat agents) and copies resources. A custom niche is a library niche edited for one business, with its own AI voice and chat agents.
  • PATCH /custom-niches/{niche_id} sets the receptionist's voice, one or two languages, extra instructions, a prompt override and custom tools under agent, and the business, services, hours and persona under profile. Saving updates the agents; there is no publish step.
  • New lookups: GET /voices, GET /demo-tools and GET /languages list the values agent.voiceId, profile.tools and agent.languages accept.
  • POST /demos takes optional client_id, business_name, website_url, import_website, description, brand_color, logo_url and custom_niche_id. With any of them niche_slug is required and the demo is created already made for that business. With none of them the request behaves as before.
  • New PUT /demos/{demo_id}/personalization sets who a demo is for, its branding, and the niche it runs on. A value sets a field, null clears it, and an omitted key is left alone.
  • Demo reads return client_id, custom_niche_id and prospect. Demo writes that personalize return agents and notes beside message and result.
  • Client branding: POST and DELETE /clients/{client_id}/logo, POST /clients/{client_id}/logo-imports and PUT /clients/{client_id}/brand-color. Client reads return logo_url and brand_color.
  • A logo sent as an address is fetched once and hosted. The stored logo_url is always the hosted copy.
  • Reading a website or a description (website_url or description on POST /custom-niches and its drafts resource, import_website or description on a demo) spends one Lumina AI credit.
  • Ten live demos are included with the plan (it was three) and 25 can be live at once (it was 10). POST /demos/{demo_id}/publications answers 409 slot_confirmation_required from the eleventh.
  • With an access token, DELETE /custom-niches/{niche_id} needs the owner's approval like other deletes a client can see: it answers 403 approval_required.

Owner approvals, client access, and onboarding in one call

  • The actions a token could not take now ask the owner instead of being refused: the call answers 403 approval_required with details.approval_id and details.approve_url. After the owner approves, repeat the call with header X-Lumina-Approval-Id (MCP: approval_id) and the same arguments. One use, 24 hours, bound to that token and that exact request. approval_pending, approval_denied, approval_consumed, approval_expired, approval_mismatch and approval_not_found say why one cannot be used. X-Lumina-Approval-Note (MCP: approval_reason) shows your reason on the card.
  • Added to what needs approval: cancelling billing on a build or a line, rotating a portal link or embed key, opening or deleting a client's stored login, creating or revoking an access token, saving a blog schedule, changing a landing page's address, and deleting a client, deal, demo, lander, form, embed, or landing-page video.
  • Still refused for every token with 403 owner_action_required: switching the active agency and the dashboard assistant's own operations. It is also the answer when approvals are not available on a deployment.
  • New: GET /clients/{client_id}/onboarding-context, GET /onboarding/design-context and POST /onboarding/blueprints build a whole intake form, and file the logins it needs, in one call.
  • New: GET /onboarding/access-catalog, GET and POST /clients/{client_id}/access, DELETE /clients/{client_id}/access/{access_item_id} and POST /clients/{client_id}/access/{access_item_id}/reveals.
  • New: Scope Calculator sessions (/scope-sessions), the blog profile and schedule (/blogs/profile, /blogs/schedule), beta features (/agency/beta-features), lander facts, slug, copies, website import and media, and access tokens (/access-tokens).
  • MCP: a lumina_check_approval tool, so compact mode lists five tools.

Live surface os is the AI CRM, with nothing to build

  • publishTarget os now serves the AI CRM for the demo's vertical (nicheId): one CRM template filled with that vertical's sample records. It replaces the AI-built custom demo.
  • Nothing has to be built or published first. PUT /demos/{demo_id} and POST /demos/{demo_id}/publications no longer answer 409 custom_demo_not_published.
  • A demo with publishTarget os publishes with no nodes. Demos that already served os now serve the AI CRM for their vertical.
  • PUT /demos/{demo_id} with os for a demo that is unknown or another agency's now answers 422 operation_rejected, as it always has for page. It answered 404 not_found.
  • console still answers 400 publish_target_removed, now with "console was replaced by os, the AI CRM for the demo's vertical".
  • The demo_lead notification event is removed from the muted-events list, because "Get this built" no longer exists: GET /agency/notifications no longer lists it and PUT /agency/notifications no longer accepts it in events.

MCP server and write access for tokens

  • New token scope api:write: POST, PUT, PATCH, and DELETE outside Blogs. The request runs as the member who created the token. Existing tokens are unchanged and stay read-only.
  • A change sent with a token that lacks api:write still answers 403 insufficient_scope; the message now names the scope.
  • A few actions stay with the owner in the dashboard and answer 403 owner_action_required for every token: team changes, the billing portal, notification settings, account deletion, renaming the subdomain, removing a domain, changing the referral code, resuming billing, the assistant, buying a demo slot (confirmSlots above 0), and deleting a client or project with acknowledge_billing.
  • New MCP server at /api/mcp: every operation as a tool, authenticated with the same access tokens. ?mode=compact and ?toolsets= narrow the tool list.
  • POST /demos takes an optional niche_slug that sets the new demo's default vertical.

Live surface: console replaced by os

  • PUT /demos/{demo_id} takes publishTarget page or os. console answers 400 publish_target_removed: "console was replaced by os; build a custom demo first".
  • os serves the demo's custom demo. Without a published custom demo version, PUT /demos/{demo_id} and POST /demos/{demo_id}/publications answer 409 custom_demo_not_published.
  • Demos that served console now serve page. Reads return publish_target page or os.
  • Custom demos are built and published in the app. The API can serve one but cannot start a build.

Reference

Agency

GET /api/v1/agency/membershipsList the agencies you belong to

Use an agency_id as X-Lumina-Agency-Id on bearer requests to pin the agency without changing the dashboard selection.

Permission: member. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "agency_id": {
                "type": "string"
              },
              "role": {
                "type": "string",
                "enum": [
                  "member",
                  "owner"
                ]
              },
              "permissions": {
                "type": "object",
                "additionalProperties": false
              },
              "agencies": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "logo_url": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "name",
                  "logo_url"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "agency_id",
              "role",
              "permissions",
              "agencies"
            ],
            "additionalProperties": false
          }
        },
        "current_agency_id": {
          "type": "string"
        }
      },
      "required": [
        "items",
        "current_agency_id"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false
          }
        },
        "current_agency_id": {
          "type": "string"
        }
      },
      "required": [
        "items",
        "current_agency_id"
      ],
      "additionalProperties": false
    }
  ]
}
PUT /api/v1/agency/selectionChange your default active agency

Changes the agency selected in the dashboard and subsequent requests without X-Lumina-Agency-Id. Only your existing memberships may be selected. Automation should prefer the request header for isolation.

Permission: member. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "agency_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "agency_id"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "agency_id": {
      "type": "string"
    }
  },
  "required": [
    "agency_id"
  ],
  "additionalProperties": false
}
GET /api/v1/agencyGet the active agency and your permissions

Get the active agency and your permissions

Permission: member. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "subdomain": {
      "type": "string",
      "nullable": true
    },
    "logo_url": {
      "type": "string",
      "nullable": true
    },
    "brand": {
      "type": "object",
      "properties": {
        "primary": {
          "type": "string"
        },
        "accent": {
          "type": "string"
        },
        "background": {
          "type": "string"
        },
        "foreground": {
          "type": "string"
        },
        "font": {
          "type": "string"
        },
        "tagline": {
          "type": "string"
        },
        "support_email": {
          "type": "string"
        },
        "support_phone": {
          "type": "string"
        },
        "booking_url": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "contact_email": {
      "type": "string",
      "nullable": true
    },
    "website_url": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "member",
        "owner"
      ]
    },
    "permissions": {
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "name",
    "slug",
    "subdomain",
    "logo_url",
    "brand",
    "contact_email",
    "website_url",
    "created_at",
    "updated_at",
    "role",
    "permissions"
  ],
  "additionalProperties": false
}
GET /api/v1/agency/entitlementsGet plan limits and included features

Get plan limits and included features

Permission: member. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "plan": {
      "type": "string",
      "enum": [
        "free",
        "pro",
        "agency",
        "enterprise"
      ]
    },
    "label": {
      "type": "string"
    },
    "priceUsd": {
      "type": "number",
      "nullable": true
    },
    "voiceMinutes": {
      "type": "number"
    },
    "chatMessages": {
      "type": "number"
    },
    "seoAudits": {
      "type": "number"
    },
    "assistantMessages": {
      "type": "number"
    },
    "publishedDashboards": {
      "type": "number"
    },
    "publishedLanders": {
      "type": "number"
    },
    "landerVideoBytes": {
      "type": "number"
    },
    "customSubdomain": {
      "type": "boolean"
    },
    "teamSeats": {
      "type": "number"
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "plan",
    "label",
    "priceUsd",
    "voiceMinutes",
    "chatMessages",
    "seoAudits",
    "assistantMessages",
    "publishedDashboards",
    "publishedLanders",
    "landerVideoBytes",
    "customSubdomain",
    "teamSeats",
    "features"
  ],
  "additionalProperties": false
}

Branding

PATCH /api/v1/agency/brandingUpdate agency branding and contact details

Only supplied fields change. Null clears optional values. Colors use six-digit hex values including #. Changes affect the existing branded demos and portals.

Permission: brand:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "primary": {
      "nullable": true,
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "accent": {
      "nullable": true,
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "tagline": {
      "nullable": true,
      "type": "string",
      "maxLength": 120
    },
    "booking_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 400,
      "format": "uri"
    },
    "website_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 400,
      "format": "uri"
    },
    "contact_email": {
      "nullable": true,
      "type": "string",
      "maxLength": 200,
      "format": "email"
    },
    "support_email": {
      "nullable": true,
      "type": "string",
      "maxLength": 200,
      "format": "email"
    },
    "support_phone": {
      "nullable": true,
      "type": "string",
      "maxLength": 40
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/agency/subdomainClaim or change the agency subdomain

Claim or change the agency subdomain

Permission: brand:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "subdomain": {
      "type": "string",
      "minLength": 3,
      "maxLength": 32
    }
  },
  "required": [
    "subdomain"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/agency/logoSet or remove an uploaded logo

The URL must refer to this agency's uploaded file in agency-assets. Use null to remove the logo.

Permission: brand:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "url": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000,
      "format": "uri"
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/agency/domainsList agency domains

Paginated agency_domains records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: brand:manage. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "surface": {
            "type": "string",
            "enum": [
              "demo",
              "portal",
              "landers"
            ]
          },
          "hostname": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "error",
              "active",
              "pending"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "surface",
          "hostname",
          "status",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/agency/domains/{domain_id}Get one agency domains record

Get one agency domains record

Permission: brand:manage. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "surface": {
      "type": "string",
      "enum": [
        "demo",
        "portal",
        "landers"
      ]
    },
    "hostname": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "error",
        "active",
        "pending"
      ]
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "surface",
    "hostname",
    "status",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/agency/domainsAttach a custom demo, portal, or landing page domain

Attach a custom demo, portal, or landing page domain

Permission: brand:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "surface": {
      "type": "string",
      "enum": [
        "demo",
        "portal",
        "landers"
      ]
    },
    "hostname": {
      "type": "string",
      "minLength": 1,
      "maxLength": 253
    }
  },
  "required": [
    "surface",
    "hostname"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/agency/domains/{domain_id}/verificationsRecheck custom domain DNS and ownership

Recheck custom domain DNS and ownership

Permission: brand:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/agency/domains/{domain_id}Detach a custom domain

Detach a custom domain

Permission: brand:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/agency/logoUpload the agency logo

Send a PNG, JPEG, or WebP file as standard base64. Decoded size must be at most 2 MiB; file signatures are checked. The response contains the public logo URL.

Permission: brand:manage. Success: 201. Maximum body: 3145728 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "content_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "content_base64": {
      "type": "string",
      "minLength": 4,
      "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
    }
  },
  "required": [
    "filename",
    "content_type",
    "content_base64"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Clients

GET /api/v1/clientsList clients

List clients

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "status": {
      "type": "string",
      "enum": [
        "lead",
        "active",
        "paused",
        "churned"
      ]
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    },
    "total": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}Get a client

Get a client

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "additionalProperties": false
}
POST /api/v1/clientsCreate a client and intake form

Creates the client, a portal link, and the client's onboarding form using the agency workflow. Optional retail prices are USD dollars and create a self-managed project. The portal URL is a secret; store it securely.

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "business_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "contact_name": {
      "nullable": true,
      "type": "string",
      "maxLength": 120
    },
    "email": {
      "nullable": true,
      "type": "string",
      "maxLength": 200,
      "format": "email"
    },
    "phone": {
      "nullable": true,
      "type": "string",
      "maxLength": 40
    },
    "website_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 400,
      "format": "uri"
    },
    "notes": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000
    },
    "niche_slug": {
      "type": "string",
      "maxLength": 64
    },
    "retail_monthly": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "retail_setup": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "deliverable": {
      "type": "string",
      "maxLength": 200
    }
  },
  "required": [
    "business_name"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PATCH /api/v1/clients/{client_id}Update client details

Only supplied fields change. Null clears an optional field. Status and portal controls have separate resources.

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "business_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "contact_name": {
      "nullable": true,
      "type": "string",
      "maxLength": 120
    },
    "email": {
      "nullable": true,
      "type": "string",
      "maxLength": 200,
      "format": "email"
    },
    "phone": {
      "nullable": true,
      "type": "string",
      "maxLength": 40
    },
    "website_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 400,
      "format": "uri"
    },
    "notes": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/clients/{client_id}Delete a client and associated records

Requires the exact business name in confirm. Active billing requires acknowledge_billing=true; the existing workflow cancels subscriptions before removing records and uploaded files.

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "confirm": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "acknowledge_billing": {
      "type": "boolean"
    }
  },
  "required": [
    "confirm"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/portal-link/rotationsRotate the client portal link

Invalidates the previous portal link and returns the replacement.

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/clients/{client_id}/portal-accessEnable or disable the client portal

Enable or disable the client portal

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/clients/{client_id}/statusChange client status

Change client status

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "lead",
        "active",
        "paused",
        "churned"
      ]
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/logo-importsSet a client's logo from an image address

Fetches the PNG, JPEG, or WebP at url (at most 2 MiB), checks it is an image, and hosts a copy. The client's logo_url becomes the hosted copy, never the address you sent, and result.url returns it. Every demo linked to this client wears the logo unless the demo has one of its own. To send the file itself, use uploadClientLogo.

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2000,
      "format": "uri"
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/clients/{client_id}/logoRemove a client's logo

Clears logo_url and deletes the hosted file. Demos linked to this client go back to showing the agency's logo unless they have one of their own.

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/clients/{client_id}/brand-colorSet or clear a client's brand colour

color is a six-digit hex colour such as #1f6feb, or null to clear it. Demos linked to this client are tinted with it unless the demo has a colour of its own.

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "color": {
      "nullable": true,
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    }
  },
  "required": [
    "color"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/clients/{client_id}/portal-stageChange the client-facing delivery stage

Change the client-facing delivery stage

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "stage": {
      "type": "string",
      "enum": [
        "getting_set_up",
        "scheduled",
        "in_build",
        "revisions",
        "live",
        "on_hold"
      ]
    }
  },
  "required": [
    "stage"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/intake-submissionsList client intake submissions

Paginated onboarding_submissions records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "client_id": {
            "type": "string",
            "nullable": true
          },
          "form_id": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "in_progress",
              "submitted",
              "invited",
              "accepted"
            ]
          },
          "invited_email": {
            "type": "string",
            "nullable": true
          },
          "data": {},
          "submitted_at": {
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "client_id",
          "form_id",
          "status",
          "invited_email",
          "data",
          "submitted_at",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/intake-submissions/{submission_id}Get one client intake submissions record

Get one client intake submissions record

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "form_id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "in_progress",
        "submitted",
        "invited",
        "accepted"
      ]
    },
    "invited_email": {
      "type": "string",
      "nullable": true
    },
    "data": {},
    "submitted_at": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "client_id",
    "form_id",
    "status",
    "invited_email",
    "data",
    "submitted_at",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/contractsList client contracts

Paginated client_contracts records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "client_id": {
            "type": "string"
          },
          "request_id": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "link",
              "other",
              "pdf",
              "image"
            ]
          },
          "storage_path": {
            "type": "string",
            "nullable": true
          },
          "external_url": {
            "type": "string",
            "nullable": true
          },
          "signed_at": {
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "client_id",
          "request_id",
          "title",
          "kind",
          "storage_path",
          "external_url",
          "signed_at",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/contracts/{contract_id}Get one client contracts record

Get one client contracts record

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string"
    },
    "kind": {
      "type": "string",
      "enum": [
        "link",
        "other",
        "pdf",
        "image"
      ]
    },
    "storage_path": {
      "type": "string",
      "nullable": true
    },
    "external_url": {
      "type": "string",
      "nullable": true
    },
    "signed_at": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "client_id",
    "request_id",
    "title",
    "kind",
    "storage_path",
    "external_url",
    "signed_at",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/support-requestsList client support requests

Paginated client_support_requests records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "client_id": {
            "type": "string"
          },
          "request_id": {
            "type": "string",
            "nullable": true
          },
          "subject": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "in_progress",
              "open",
              "resolved"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "client_id",
          "request_id",
          "subject",
          "body",
          "status",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/support-requests/{ticket_id}Get one client support requests record

Get one client support requests record

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "nullable": true
    },
    "subject": {
      "type": "string"
    },
    "body": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "in_progress",
        "open",
        "resolved"
      ]
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "client_id",
    "request_id",
    "subject",
    "body",
    "status",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/revision-requestsList client revision requests

Paginated client_revision_requests records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "client_id": {
            "type": "string"
          },
          "request_id": {
            "type": "string",
            "nullable": true
          },
          "changes": {
            "type": "string"
          },
          "must_keep": {
            "type": "string",
            "nullable": true
          },
          "priority": {
            "type": "string",
            "enum": [
              "must",
              "should",
              "nice"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "in_progress",
              "open",
              "resolved"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "client_id",
          "request_id",
          "changes",
          "must_keep",
          "priority",
          "status",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/revision-requests/{id}Get one client revision requests record

Get one client revision requests record

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "request_id": {
      "type": "string",
      "nullable": true
    },
    "changes": {
      "type": "string"
    },
    "must_keep": {
      "type": "string",
      "nullable": true
    },
    "priority": {
      "type": "string",
      "enum": [
        "must",
        "should",
        "nice"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "in_progress",
        "open",
        "resolved"
      ]
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "client_id",
    "request_id",
    "changes",
    "must_keep",
    "priority",
    "status",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/projects/{project_id}Get a client portal project

Get a client portal project

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/projects/{project_id}/updatesList the updates visible in the client portal

List the updates visible in the client portal

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/portal-linkGet the existing client portal link

Returns a sensitive portal URL. Possession of the URL grants client portal access, so this requires manage permission.

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "url",
    "enabled"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/intake-linksCreate or retrieve the client's intake link

Reuses the client's existing form and submission. Set rotate=true to invalidate the old URL while retaining answers.

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "rotate": {
      "default": false,
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/onboarding-formEnsure the client has a dedicated intake form

Ensure the client has a dedicated intake form

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "template_form_id": {
      "type": "string",
      "format": "uuid"
    },
    "niche_slug": {
      "type": "string",
      "maxLength": 64
    },
    "offer_slug": {
      "type": "string",
      "maxLength": 64
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/projectsList the projects on a client's portal

List the projects on a client's portal

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/projectsRecord a project the agency delivers itself

Creates a self-managed project visible in the client portal. Retail prices are in USD dollars. Lumina does not bill this project.

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "deliverable": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "retail_monthly": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "retail_setup": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "notes": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "deliverable",
    "retail_monthly",
    "retail_setup"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/clients/{client_id}/projects/{project_id}Replace a self-managed project's details

Replace a self-managed project's details

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "deliverable": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "retail_monthly": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "retail_setup": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "notes": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "deliverable",
    "retail_monthly",
    "retail_setup"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/clients/{client_id}/projects/{project_id}/statusChange a self-managed project's delivery status

Change a self-managed project's delivery status

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "in_progress",
        "delivered",
        "canceled"
      ]
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/clients/{client_id}/projects/{project_id}Delete a client project

Removing a Lumina-managed project also requires fulfillment:manage. acknowledge_billing=true authorizes immediate cancellation and forfeits the remaining paid period where the project has live billing.

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "acknowledge_billing": {
      "default": false,
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/projects/{project_id}/updatesPost a client-visible project update

Post a client-visible project update

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "body": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "title"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/contractsAdd a linked document to the client portal

Add a linked document to the client portal

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "external_url": {
      "type": "string",
      "maxLength": 600,
      "format": "uri"
    }
  },
  "required": [
    "title",
    "external_url"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PATCH /api/v1/clients/{client_id}/contracts/{contract_id}Update a portal document

Update a portal document

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "external_url": {
      "type": "string",
      "maxLength": 600,
      "format": "uri"
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/clients/{client_id}/contracts/{contract_id}Remove a client document and its stored file

Remove a client document and its stored file

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/clients/{client_id}/support-requests/{ticket_id}/statusChange a support request's status

Change a support request's status

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "open",
        "in_progress",
        "resolved"
      ]
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/intake-submissions/{submission_id}/download-linksCreate expiring links for a client's submitted intake files

Create expiring links for a client's submitted intake files

Permission: clients:view. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "expires_in": {
      "default": 900,
      "type": "integer",
      "minimum": 60,
      "maximum": 3600
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "files": {
          "type": "array",
          "items": {}
        },
        "expires_at": {}
      },
      "required": [
        "files",
        "expires_at"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "files": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "nullable": true
              },
              "path": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "size": {
                "type": "number"
              },
              "type": {
                "type": "string"
              },
              "field": {
                "type": "string"
              }
            },
            "required": [
              "url",
              "path",
              "name",
              "size",
              "type",
              "field"
            ],
            "additionalProperties": false
          }
        },
        "expires_at": {
          "type": "string"
        }
      },
      "required": [
        "files",
        "expires_at"
      ],
      "additionalProperties": false
    }
  ]
}
POST /api/v1/clients/{client_id}/logoUpload a client's logo

Send a PNG, JPEG, or WebP file as standard base64. Decoded size must be at most 2 MiB; file signatures are checked. The response contains the hosted logo URL in result.url. Every demo linked to this client wears the logo unless the demo has one of its own. To give an image address instead of the file, use importClientLogo.

Permission: clients:manage. Success: 201. Maximum body: 3145728 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "content_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "content_base64": {
      "type": "string",
      "minLength": 4,
      "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
    }
  },
  "required": [
    "filename",
    "content_type",
    "content_base64"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/contract-filesUpload a private contract to the client portal

Send a document or image as standard base64. Decoded size must be at most 10 MiB. File signatures are checked and the file is stored in the agency's private folder. List contracts to retrieve the newly created record.

Permission: clients:manage. Success: 201. Maximum body: 15728640 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "content_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "content_base64": {
      "type": "string",
      "minLength": 4,
      "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    }
  },
  "required": [
    "filename",
    "content_type",
    "content_base64",
    "title"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/contracts/{contract_id}/download-linksCreate an expiring contract download link

Create an expiring contract download link

Permission: clients:view. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "expires_in": {
      "default": 900,
      "type": "integer",
      "minimum": 60,
      "maximum": 3600
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "nullable": true
        },
        "expires_at": {}
      },
      "required": [
        "url",
        "expires_at"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "expires_at": {
          "type": "string"
        }
      },
      "required": [
        "url",
        "expires_at"
      ],
      "additionalProperties": false
    }
  ]
}

Settings

GET /api/v1/agency/deletion-requestsList agency deletion requests

Paginated account_deletion_requests records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string",
            "nullable": true
          },
          "agency_name": {
            "type": "string"
          },
          "requested_by_user_id": {
            "type": "string",
            "nullable": true
          },
          "requester_email": {
            "type": "string"
          },
          "reason": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "completed",
              "in_progress",
              "declined"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "agency_name",
          "requested_by_user_id",
          "requester_email",
          "reason",
          "status",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/agency/deletion-requests/{id}Get one agency deletion requests record

Get one agency deletion requests record

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string",
      "nullable": true
    },
    "agency_name": {
      "type": "string"
    },
    "requested_by_user_id": {
      "type": "string",
      "nullable": true
    },
    "requester_email": {
      "type": "string"
    },
    "reason": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "completed",
        "in_progress",
        "declined"
      ]
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "agency_name",
    "requested_by_user_id",
    "requester_email",
    "reason",
    "status",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/agency/notificationsGet notification channels and enabled events

Webhook URLs are write-only. The response indicates whether each webhook is configured.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "email_enabled": {
      "type": "boolean"
    },
    "email_to": {
      "type": "string",
      "nullable": true
    },
    "discord_enabled": {
      "type": "boolean"
    },
    "discord_configured": {
      "type": "boolean"
    },
    "slack_enabled": {
      "type": "boolean"
    },
    "slack_configured": {
      "type": "boolean"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "available_events": {
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "email_enabled",
    "email_to",
    "discord_enabled",
    "discord_configured",
    "slack_enabled",
    "slack_configured",
    "events",
    "available_events"
  ],
  "additionalProperties": false
}
PUT /api/v1/agency/notificationsReplace notification preferences

All channel flags and the complete enabled-event list are required. Omit webhook URLs to keep their current values; use null to clear one. Enablement requires a valid webhook URL.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "email_enabled": {
      "type": "boolean"
    },
    "email_to": {
      "nullable": true,
      "type": "string",
      "format": "email"
    },
    "discord_enabled": {
      "type": "boolean"
    },
    "discord_webhook_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000,
      "format": "uri"
    },
    "slack_enabled": {
      "type": "boolean"
    },
    "slack_webhook_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000,
      "format": "uri"
    },
    "events": {
      "maxItems": 7,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "support_request",
          "revision_submitted",
          "usage_threshold",
          "fulfillment_status",
          "onboarding_submitted",
          "access_provided",
          "lander_lead"
        ]
      }
    }
  },
  "required": [
    "email_enabled",
    "email_to",
    "discord_enabled",
    "slack_enabled",
    "events"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/agency/deletion-requestsRequest account deletion

Queues an account deletion request for the Lumina operator. This does not immediately delete the agency or cancel active services.

Permission: owner. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/agency/beta-featuresList beta features and whether each is on

Every beta feature, whether this deployment offers it, and whether the agency has turned it on.

Permission: member. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "enum": [
              "landers"
            ]
          },
          "label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "available": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          }
        },
        "required": [
          "key",
          "label",
          "description",
          "available",
          "enabled"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
PUT /api/v1/agency/beta-featuresTurn a beta feature on or off

Owner only. Turning a feature on adds it to the dashboard sidebar for the whole team; turning it off hides it again. Nothing is deleted either way.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "feature": {
      "type": "string",
      "enum": [
        "landers"
      ]
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "feature",
    "enabled"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Demos

GET /api/v1/demosList demos

Paginated demo_dashboards records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "niche_id": {
            "type": "string",
            "nullable": true
          },
          "client_id": {
            "type": "string",
            "nullable": true
          },
          "custom_niche_id": {
            "type": "string",
            "nullable": true
          },
          "prospect": {
            "type": "object",
            "properties": {
              "business_name": {
                "type": "string"
              },
              "website_url": {
                "type": "string"
              },
              "logo_url": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "brand_color": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "theme": {
            "type": "object",
            "properties": {
              "primary": {
                "type": "string"
              },
              "accent": {
                "type": "string"
              },
              "background": {
                "type": "string"
              },
              "foreground": {
                "type": "string"
              },
              "font": {
                "type": "string"
              },
              "tagline": {
                "type": "string"
              },
              "support_email": {
                "type": "string"
              },
              "support_phone": {
                "type": "string"
              },
              "booking_url": {
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "published",
              "archived"
            ]
          },
          "published_at": {
            "type": "string",
            "nullable": true
          },
          "footer_note": {
            "type": "string",
            "nullable": true
          },
          "show_section_nav": {
            "type": "boolean"
          },
          "access_mode": {
            "type": "string",
            "enum": [
              "public",
              "email_gate",
              "passcode"
            ]
          },
          "voice_minute_budget": {
            "type": "number",
            "nullable": true
          },
          "chat_message_budget": {
            "type": "number",
            "nullable": true
          },
          "visitor_daily_call_limit": {
            "type": "number"
          },
          "visitor_daily_message_limit": {
            "type": "number"
          },
          "publish_target": {
            "type": "string",
            "enum": [
              "page",
              "os"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "name",
          "slug",
          "niche_id",
          "client_id",
          "custom_niche_id",
          "prospect",
          "theme",
          "status",
          "published_at",
          "footer_note",
          "show_section_nav",
          "access_mode",
          "voice_minute_budget",
          "chat_message_budget",
          "visitor_daily_call_limit",
          "visitor_daily_message_limit",
          "publish_target",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/demos/{demo_id}Get one demos record

Get one demos record

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "niche_id": {
      "type": "string",
      "nullable": true
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "custom_niche_id": {
      "type": "string",
      "nullable": true
    },
    "prospect": {
      "type": "object",
      "properties": {
        "business_name": {
          "type": "string"
        },
        "website_url": {
          "type": "string"
        },
        "logo_url": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "brand_color": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "theme": {
      "type": "object",
      "properties": {
        "primary": {
          "type": "string"
        },
        "accent": {
          "type": "string"
        },
        "background": {
          "type": "string"
        },
        "foreground": {
          "type": "string"
        },
        "font": {
          "type": "string"
        },
        "tagline": {
          "type": "string"
        },
        "support_email": {
          "type": "string"
        },
        "support_phone": {
          "type": "string"
        },
        "booking_url": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "published",
        "archived"
      ]
    },
    "published_at": {
      "type": "string",
      "nullable": true
    },
    "footer_note": {
      "type": "string",
      "nullable": true
    },
    "show_section_nav": {
      "type": "boolean"
    },
    "access_mode": {
      "type": "string",
      "enum": [
        "public",
        "email_gate",
        "passcode"
      ]
    },
    "voice_minute_budget": {
      "type": "number",
      "nullable": true
    },
    "chat_message_budget": {
      "type": "number",
      "nullable": true
    },
    "visitor_daily_call_limit": {
      "type": "number"
    },
    "visitor_daily_message_limit": {
      "type": "number"
    },
    "publish_target": {
      "type": "string",
      "enum": [
        "page",
        "os"
      ]
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "name",
    "slug",
    "niche_id",
    "client_id",
    "custom_niche_id",
    "prospect",
    "theme",
    "status",
    "published_at",
    "footer_note",
    "show_section_nav",
    "access_mode",
    "voice_minute_budget",
    "chat_message_budget",
    "visitor_daily_call_limit",
    "visitor_daily_message_limit",
    "publish_target",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/demosCreate a draft demo, optionally made for one business

Creates a draft from the starter layout. niche_slug sets the demo's default vertical, so every node demonstrates that niche; list the slugs with getDemoCatalog. With only name and niche_slug that is all it does. Any of the other fields makes it a demo for one business, and niche_slug is then required: client_id links a client (their name, logo and colour are used unless overridden here), business_name names the business, website_url is their site, brand_color (#rrggbb) and logo_url (an image address, which is fetched once and hosted, never linked) set what the page wears. A demo with a business to name gets a niche of its own, so the AI receptionist answers as that business; import_website reads website_url and fills that niche from it, and description does the same from a sentence or two. import_website and description each spend one Lumina AI credit and take about 20 seconds; nothing is spent when the read fails. custom_niche_id runs the demo on a custom niche you already have instead. Read notes in the answer: they say which services had no price given (the AI says "quoted on request" for those until a price is set), and whether the demo was created but could not be personalized. result.dashboardId is the new demo; result.customNicheId is its niche when one was made.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "niche_slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "client_id": {
      "type": "string",
      "format": "uuid"
    },
    "business_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "website_url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 400
    },
    "import_website": {
      "type": "boolean"
    },
    "description": {
      "type": "string",
      "minLength": 12,
      "maxLength": 4000
    },
    "brand_color": {
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "logo_url": {
      "type": "string",
      "maxLength": 2000,
      "format": "uri"
    },
    "custom_niche_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "agents": {
      "type": "string",
      "enum": [
        "error",
        "pending",
        "syncing",
        "live"
      ],
      "nullable": true
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result",
    "agents",
    "notes"
  ],
  "additionalProperties": false
}
PUT /api/v1/demos/{demo_id}/personalizationSet who a demo is for, what it wears, and the niche it runs on

For client_id, business_name, website_url, brand_color, logo_url and custom_niche_id: a value sets it, null clears it, and a key you leave out is not changed. client_id links a client, whose name, logo and colour are used wherever the demo has none of its own. logo_url is an image address that is fetched once and hosted, never linked; null removes the demo's own logo. custom_niche_id runs the demo on a custom niche you already have, and null sends it back to the library niche. When the demo has no custom niche and there is a business to name, one is made for it, so the AI receptionist answers as that business; create_niche false stops that. import_website reads the demo's website (website_url, or the client's) and fills the demo's niche from it; description does the same from a sentence or two. import_website and description each spend one Lumina AI credit and take about 20 seconds; nothing is spent when the read fails. Read notes in the answer for services with no price given and a sync that did not go through; agents says where the demo's own voice and chat agents stand.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "client_id": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    },
    "business_name": {
      "nullable": true,
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "website_url": {
      "nullable": true,
      "type": "string",
      "minLength": 1,
      "maxLength": 400
    },
    "brand_color": {
      "nullable": true,
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "logo_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000,
      "format": "uri"
    },
    "custom_niche_id": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    },
    "import_website": {
      "type": "boolean"
    },
    "description": {
      "type": "string",
      "minLength": 12,
      "maxLength": 4000
    },
    "create_niche": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "agents": {
      "type": "string",
      "enum": [
        "error",
        "pending",
        "syncing",
        "live"
      ],
      "nullable": true
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result",
    "agents",
    "notes"
  ],
  "additionalProperties": false
}
PUT /api/v1/demos/{demo_id}Save demo settings and the complete node layout

Replaces settings and the ordered node list. Use null IDs for new nodes; retain existing IDs for unchanged nodes. A passcode is write-only. Publishing is a separate operation.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "nicheId": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    },
    "accessMode": {
      "type": "string",
      "enum": [
        "public",
        "email_gate",
        "passcode"
      ]
    },
    "passcode": {
      "nullable": true,
      "type": "string",
      "minLength": 4,
      "maxLength": 200
    },
    "footerNote": {
      "nullable": true,
      "type": "string",
      "maxLength": 500
    },
    "showSectionNav": {
      "type": "boolean"
    },
    "voiceMinuteBudget": {
      "nullable": true,
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "chatMessageBudget": {
      "nullable": true,
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "visitorDailyCallLimit": {
      "type": "integer",
      "minimum": 0,
      "maximum": 50
    },
    "visitorDailyMessageLimit": {
      "type": "integer",
      "minimum": 0,
      "maximum": 500
    },
    "publishTarget": {
      "type": "string",
      "enum": [
        "page",
        "os"
      ]
    },
    "nodes": {
      "maxItems": 60,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "nullable": true,
            "type": "string",
            "format": "uuid"
          },
          "nodeTypeId": {
            "type": "string",
            "format": "uuid"
          },
          "nodeSlug": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "nicheId": {
            "nullable": true,
            "type": "string",
            "format": "uuid"
          },
          "columnSpan": {
            "type": "integer",
            "minimum": 1,
            "maximum": 3
          },
          "enabled": {
            "type": "boolean"
          },
          "config": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "required": [
          "id",
          "nodeTypeId",
          "nodeSlug",
          "nicheId",
          "columnSpan",
          "enabled",
          "config"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "name",
    "nicheId",
    "accessMode",
    "footerNote",
    "showSectionNav",
    "voiceMinuteBudget",
    "chatMessageBudget",
    "visitorDailyCallLimit",
    "visitorDailyMessageLimit",
    "publishTarget",
    "nodes"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/demos/{demo_id}Delete a saved demo

Delete a saved demo

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/demos/{demo_id}/copiesDuplicate a demo as a draft

Duplicate a demo as a draft

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/demos/{demo_id}/endpointChange the demo URL endpoint

Change the demo URL endpoint

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    }
  },
  "required": [
    "endpoint"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/demos/{demo_id}/publicationsPublish a demo

Requires a claimed subdomain, plan entitlements, and enabled nodes unless the demo's publishTarget is os (the AI CRM for its vertical, which needs none). Each live demo has its own endpoint and stays live when another is published. The plan includes 10 live demos, and 25 is the ceiling. Past the included ones each needs a paid demo slot: a 409 includes the price quote; repeat with the exact confirmSlots value to authorize that purchase.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string",
      "maxLength": 100
    },
    "confirmSlots": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/demos/{demo_id}/publicationUnpublish a demo

Unpublish a demo

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/demos/{demo_id}/nodesGet the complete ordered demo layout

Get the complete ordered demo layout

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
GET /api/v1/demos/catalogGet available niches, node types, and editable configuration fields

Use catalog IDs and matching slugs when replacing a demo layout. Platform catalog content is shared and cannot be edited by agency accounts.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "niches": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    },
    "node_types": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "configuration": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "text",
                    "textarea",
                    "url",
                    "select",
                    "lines",
                    "sample",
                    "quotes",
                    "tiers",
                    "sliders"
                  ]
                },
                "help": {
                  "type": "string"
                },
                "placeholder": {
                  "type": "string"
                },
                "maxLength": {
                  "type": "number"
                },
                "options": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string"
                      },
                      "label": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "value",
                      "label"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "key",
                "label",
                "type"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "configuration"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "niches",
    "node_types"
  ],
  "additionalProperties": false
}

Embeds

GET /api/v1/embedsList embeds

Paginated demo_embeds records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "dashboard_id": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "layout": {},
          "allowed_origins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "allow_any_origin": {
            "type": "boolean"
          },
          "voice_minute_budget": {
            "type": "number",
            "nullable": true
          },
          "chat_message_budget": {
            "type": "number",
            "nullable": true
          },
          "visitor_daily_call_limit": {
            "type": "number"
          },
          "visitor_daily_message_limit": {
            "type": "number"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "dashboard_id",
          "key",
          "name",
          "enabled",
          "layout",
          "allowed_origins",
          "allow_any_origin",
          "voice_minute_budget",
          "chat_message_budget",
          "visitor_daily_call_limit",
          "visitor_daily_message_limit",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/embeds/{embed_id}Get one embeds record

Get one embeds record

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "dashboard_id": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "layout": {},
    "allowed_origins": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allow_any_origin": {
      "type": "boolean"
    },
    "voice_minute_budget": {
      "type": "number",
      "nullable": true
    },
    "chat_message_budget": {
      "type": "number",
      "nullable": true
    },
    "visitor_daily_call_limit": {
      "type": "number"
    },
    "visitor_daily_message_limit": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "dashboard_id",
    "key",
    "name",
    "enabled",
    "layout",
    "allowed_origins",
    "allow_any_origin",
    "voice_minute_budget",
    "chat_message_budget",
    "visitor_daily_call_limit",
    "visitor_daily_message_limit",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/embeds/{embed_id}/origin-blocksList embed origin blocks

Paginated embed_origin_blocks records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "embed_id": {
            "type": "string"
          },
          "origin": {
            "type": "string"
          },
          "attempts": {
            "type": "number"
          },
          "first_seen_at": {
            "type": "string"
          },
          "last_seen_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "embed_id",
          "origin",
          "attempts",
          "first_seen_at",
          "last_seen_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/embeds/{embed_id}/origin-blocks/{id}Get one embed origin blocks record

Get one embed origin blocks record

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "embed_id": {
      "type": "string"
    },
    "origin": {
      "type": "string"
    },
    "attempts": {
      "type": "number"
    },
    "first_seen_at": {
      "type": "string"
    },
    "last_seen_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "embed_id",
    "origin",
    "attempts",
    "first_seen_at",
    "last_seen_at"
  ],
  "additionalProperties": false
}
POST /api/v1/embedsCreate an embed

Provide a saved dashboardId, or new to create the receptionist-and-chat starter demo. New embeds allow no domains until an allowlist is supplied with PATCH. Bubble mode requires exactly one interactive node.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "dashboardId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "string",
          "enum": [
            "new"
          ]
        }
      ]
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "mode": {
      "default": "inline",
      "type": "string",
      "enum": [
        "inline",
        "bubble"
      ]
    },
    "nicheId": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "dashboardId",
    "name"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PATCH /api/v1/embeds/{embed_id}Update embed layout, domains, or budgets

Only supplied fields change, including individual layout properties. Domains are normalized. Invalid domains reject the request before any write. Budgets are nonnegative quantities; null removes the per-embed cap.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "enabled": {
      "type": "boolean"
    },
    "dashboardId": {
      "type": "string",
      "format": "uuid"
    },
    "layout": {
      "type": "object",
      "properties": {
        "mode": {
          "type": "string",
          "enum": [
            "inline",
            "bubble"
          ]
        },
        "theme": {
          "type": "string",
          "enum": [
            "light",
            "dark",
            "auto"
          ]
        },
        "background": {
          "type": "string",
          "enum": [
            "surface",
            "transparent"
          ]
        },
        "inspector": {
          "type": "boolean"
        },
        "maxWidth": {
          "nullable": true,
          "type": "integer",
          "minimum": 280,
          "maximum": 1400
        },
        "height": {
          "type": "integer",
          "minimum": 240,
          "maximum": 1200
        },
        "bubblePosition": {
          "type": "string",
          "enum": [
            "bottom-right",
            "bottom-left"
          ]
        },
        "bubbleLabel": {
          "type": "string",
          "maxLength": 40
        }
      },
      "additionalProperties": false
    },
    "allowedOrigins": {
      "maxItems": 8,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      }
    },
    "voiceMinuteBudget": {
      "nullable": true,
      "type": "integer",
      "minimum": 0
    },
    "chatMessageBudget": {
      "nullable": true,
      "type": "integer",
      "minimum": 0
    },
    "visitorDailyCallLimit": {
      "type": "integer",
      "minimum": 0,
      "maximum": 50
    },
    "visitorDailyMessageLimit": {
      "type": "integer",
      "minimum": 0,
      "maximum": 500
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "dashboardId": {
      "type": "string"
    },
    "dashboardName": {
      "type": "string"
    },
    "layout": {
      "type": "object",
      "properties": {
        "mode": {
          "type": "string",
          "enum": [
            "inline",
            "bubble"
          ]
        },
        "theme": {
          "type": "string",
          "enum": [
            "light",
            "dark",
            "auto"
          ]
        },
        "background": {
          "type": "string",
          "enum": [
            "surface",
            "transparent"
          ]
        },
        "inspector": {
          "type": "boolean"
        },
        "maxWidth": {
          "type": "number",
          "nullable": true
        },
        "height": {
          "type": "number"
        },
        "bubblePosition": {
          "type": "string",
          "enum": [
            "bottom-right",
            "bottom-left"
          ]
        },
        "bubbleLabel": {
          "type": "string"
        }
      },
      "required": [
        "mode",
        "theme",
        "background",
        "inspector",
        "maxWidth",
        "height",
        "bubblePosition",
        "bubbleLabel"
      ],
      "additionalProperties": false
    },
    "allowedOrigins": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allowAnyOrigin": {
      "type": "boolean"
    },
    "voiceMinuteBudget": {
      "type": "number",
      "nullable": true
    },
    "chatMessageBudget": {
      "type": "number",
      "nullable": true
    },
    "visitorDailyCallLimit": {
      "type": "number"
    },
    "visitorDailyMessageLimit": {
      "type": "number"
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "key",
    "name",
    "enabled",
    "dashboardId",
    "dashboardName",
    "layout",
    "allowedOrigins",
    "allowAnyOrigin",
    "voiceMinuteBudget",
    "chatMessageBudget",
    "visitorDailyCallLimit",
    "visitorDailyMessageLimit",
    "createdAt",
    "updatedAt"
  ],
  "additionalProperties": false
}
PUT /api/v1/embeds/{embed_id}/any-originSet whether an embed can run on every website

When allowed=true the embed can spend its configured budgets on any website. When false, the saved allowedOrigins list applies.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "allowed": {
      "type": "boolean"
    }
  },
  "required": [
    "allowed"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/embeds/{embed_id}/key-rotationsRotate an embed key

Existing snippets stop working. The response includes the new public embed key.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "dashboardId": {
      "type": "string"
    },
    "dashboardName": {
      "type": "string"
    },
    "layout": {
      "type": "object",
      "properties": {
        "mode": {
          "type": "string",
          "enum": [
            "inline",
            "bubble"
          ]
        },
        "theme": {
          "type": "string",
          "enum": [
            "light",
            "dark",
            "auto"
          ]
        },
        "background": {
          "type": "string",
          "enum": [
            "surface",
            "transparent"
          ]
        },
        "inspector": {
          "type": "boolean"
        },
        "maxWidth": {
          "type": "number",
          "nullable": true
        },
        "height": {
          "type": "number"
        },
        "bubblePosition": {
          "type": "string",
          "enum": [
            "bottom-right",
            "bottom-left"
          ]
        },
        "bubbleLabel": {
          "type": "string"
        }
      },
      "required": [
        "mode",
        "theme",
        "background",
        "inspector",
        "maxWidth",
        "height",
        "bubblePosition",
        "bubbleLabel"
      ],
      "additionalProperties": false
    },
    "allowedOrigins": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allowAnyOrigin": {
      "type": "boolean"
    },
    "voiceMinuteBudget": {
      "type": "number",
      "nullable": true
    },
    "chatMessageBudget": {
      "type": "number",
      "nullable": true
    },
    "visitorDailyCallLimit": {
      "type": "number"
    },
    "visitorDailyMessageLimit": {
      "type": "number"
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "key",
    "name",
    "enabled",
    "dashboardId",
    "dashboardName",
    "layout",
    "allowedOrigins",
    "allowAnyOrigin",
    "voiceMinuteBudget",
    "chatMessageBudget",
    "visitorDailyCallLimit",
    "visitorDailyMessageLimit",
    "createdAt",
    "updatedAt"
  ],
  "additionalProperties": false
}
DELETE /api/v1/embeds/{embed_id}Delete an embed

Delete an embed

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/embeds/{embed_id}/installationGet working script and iframe installation snippets

Get working script and iframe installation snippets

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "script": {
      "type": "string"
    },
    "iframe": {
      "type": "string",
      "nullable": true
    },
    "instructions": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "allowed_origins": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "script",
    "iframe",
    "instructions",
    "key",
    "allowed_origins"
  ],
  "additionalProperties": false
}

Analytics

GET /api/v1/leadsList demo leads

Paginated demo_leads records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "dashboard_id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "company": {
            "type": "string",
            "nullable": true
          },
          "captured_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "dashboard_id",
          "agency_id",
          "name",
          "email",
          "phone",
          "company",
          "captured_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/leads/{id}Get one demo leads record

Get one demo leads record

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "dashboard_id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "email": {
      "type": "string"
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "company": {
      "type": "string",
      "nullable": true
    },
    "captured_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "dashboard_id",
    "agency_id",
    "name",
    "email",
    "phone",
    "company",
    "captured_at"
  ],
  "additionalProperties": false
}
GET /api/v1/demo-sessionsList demo sessions

Paginated demo_sessions records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "dashboard_id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "referrer": {
            "type": "string",
            "nullable": true
          },
          "nodes_viewed": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "started_at": {
            "type": "string"
          },
          "last_seen_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "dashboard_id",
          "agency_id",
          "referrer",
          "nodes_viewed",
          "started_at",
          "last_seen_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/demo-sessions/{id}Get one demo sessions record

Get one demo sessions record

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "dashboard_id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "referrer": {
      "type": "string",
      "nullable": true
    },
    "nodes_viewed": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "started_at": {
      "type": "string"
    },
    "last_seen_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "dashboard_id",
    "agency_id",
    "referrer",
    "nodes_viewed",
    "started_at",
    "last_seen_at"
  ],
  "additionalProperties": false
}
GET /api/v1/demo-tool-callsList demo tool calls

Paginated demo_tool_calls records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "dashboard_id": {
            "type": "string",
            "nullable": true
          },
          "agency_id": {
            "type": "string",
            "nullable": true
          },
          "niche_id": {
            "type": "string",
            "nullable": true
          },
          "call_id": {
            "type": "string",
            "nullable": true
          },
          "tool_name": {
            "type": "string"
          },
          "arguments": {},
          "response": {},
          "duration_ms": {
            "type": "number",
            "nullable": true
          },
          "occurred_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "dashboard_id",
          "agency_id",
          "niche_id",
          "call_id",
          "tool_name",
          "arguments",
          "response",
          "duration_ms",
          "occurred_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/demo-tool-calls/{id}Get one demo tool calls record

Get one demo tool calls record

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "dashboard_id": {
      "type": "string",
      "nullable": true
    },
    "agency_id": {
      "type": "string",
      "nullable": true
    },
    "niche_id": {
      "type": "string",
      "nullable": true
    },
    "call_id": {
      "type": "string",
      "nullable": true
    },
    "tool_name": {
      "type": "string"
    },
    "arguments": {},
    "response": {},
    "duration_ms": {
      "type": "number",
      "nullable": true
    },
    "occurred_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "dashboard_id",
    "agency_id",
    "niche_id",
    "call_id",
    "tool_name",
    "arguments",
    "response",
    "duration_ms",
    "occurred_at"
  ],
  "additionalProperties": false
}

Landers

GET /api/v1/lander-leadsList lander leads

Paginated lander_leads records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "lander_id": {
            "type": "string",
            "nullable": true
          },
          "agency_id": {
            "type": "string"
          },
          "session_id": {
            "type": "string",
            "nullable": true
          },
          "client_id": {
            "type": "string",
            "nullable": true
          },
          "stage": {
            "type": "string",
            "enum": [
              "partial",
              "submitted"
            ]
          },
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "company": {
            "type": "string",
            "nullable": true
          },
          "answers": {},
          "score": {
            "type": "number"
          },
          "max_score": {
            "type": "number"
          },
          "qualified": {
            "type": "boolean"
          },
          "disqualify_reason": {
            "type": "string",
            "nullable": true
          },
          "committed": {
            "type": "boolean",
            "nullable": true
          },
          "utm_source": {
            "type": "string",
            "nullable": true
          },
          "utm_medium": {
            "type": "string",
            "nullable": true
          },
          "utm_campaign": {
            "type": "string",
            "nullable": true
          },
          "utm_term": {
            "type": "string",
            "nullable": true
          },
          "utm_content": {
            "type": "string",
            "nullable": true
          },
          "referrer": {
            "type": "string",
            "nullable": true
          },
          "booked_at": {
            "type": "string",
            "nullable": true
          },
          "booking_provider": {
            "type": "string",
            "nullable": true
          },
          "captured_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "lander_id",
          "agency_id",
          "session_id",
          "client_id",
          "stage",
          "email",
          "name",
          "phone",
          "company",
          "answers",
          "score",
          "max_score",
          "qualified",
          "disqualify_reason",
          "committed",
          "utm_source",
          "utm_medium",
          "utm_campaign",
          "utm_term",
          "utm_content",
          "referrer",
          "booked_at",
          "booking_provider",
          "captured_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/lander-leads/{lead_id}Get one lander leads record

Get one lander leads record

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "lander_id": {
      "type": "string",
      "nullable": true
    },
    "agency_id": {
      "type": "string"
    },
    "session_id": {
      "type": "string",
      "nullable": true
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "stage": {
      "type": "string",
      "enum": [
        "partial",
        "submitted"
      ]
    },
    "email": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "company": {
      "type": "string",
      "nullable": true
    },
    "answers": {},
    "score": {
      "type": "number"
    },
    "max_score": {
      "type": "number"
    },
    "qualified": {
      "type": "boolean"
    },
    "disqualify_reason": {
      "type": "string",
      "nullable": true
    },
    "committed": {
      "type": "boolean",
      "nullable": true
    },
    "utm_source": {
      "type": "string",
      "nullable": true
    },
    "utm_medium": {
      "type": "string",
      "nullable": true
    },
    "utm_campaign": {
      "type": "string",
      "nullable": true
    },
    "utm_term": {
      "type": "string",
      "nullable": true
    },
    "utm_content": {
      "type": "string",
      "nullable": true
    },
    "referrer": {
      "type": "string",
      "nullable": true
    },
    "booked_at": {
      "type": "string",
      "nullable": true
    },
    "booking_provider": {
      "type": "string",
      "nullable": true
    },
    "captured_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "lander_id",
    "agency_id",
    "session_id",
    "client_id",
    "stage",
    "email",
    "name",
    "phone",
    "company",
    "answers",
    "score",
    "max_score",
    "qualified",
    "disqualify_reason",
    "committed",
    "utm_source",
    "utm_medium",
    "utm_campaign",
    "utm_term",
    "utm_content",
    "referrer",
    "booked_at",
    "booking_provider",
    "captured_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/landersList landing pages with their parsed documents

Every lander in the current agency, newest edit first. Each record carries the page document, the facts it was written from, and its scripts already parsed, plus the public URL the page answers at when it is published.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "published",
              "archived"
            ]
          },
          "niche_id": {
            "type": "string",
            "nullable": true
          },
          "published_at": {
            "type": "string",
            "nullable": true
          },
          "generation_count": {
            "type": "number"
          },
          "last_generated_at": {
            "type": "string",
            "nullable": true
          },
          "created_by": {
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "nullable": true
          },
          "facts": {
            "type": "object",
            "properties": {
              "offer": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "whatItDoes": {
                    "type": "string"
                  },
                  "deliverables": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "mechanismName": {
                    "type": "string",
                    "nullable": true
                  },
                  "integrations": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "goLiveDays": {
                    "type": "number",
                    "nullable": true
                  },
                  "priceFrame": {
                    "type": "string",
                    "nullable": true
                  },
                  "capacityPerMonth": {
                    "type": "number",
                    "nullable": true
                  },
                  "leadMagnet": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "whatItIs": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "whatItIs"
                    ],
                    "additionalProperties": false,
                    "nullable": true
                  }
                },
                "required": [
                  "name",
                  "whatItDoes",
                  "deliverables",
                  "mechanismName",
                  "integrations",
                  "goLiveDays",
                  "priceFrame",
                  "capacityPerMonth",
                  "leadMagnet"
                ],
                "additionalProperties": false
              },
              "audience": {
                "type": "object",
                "properties": {
                  "nicheSlug": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string"
                  },
                  "revenueBand": {
                    "type": "string",
                    "nullable": true
                  },
                  "region": {
                    "type": "string",
                    "nullable": true
                  },
                  "notFor": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "nicheSlug",
                  "description",
                  "revenueBand",
                  "region",
                  "notFor"
                ],
                "additionalProperties": false
              },
              "pain": {
                "type": "object",
                "properties": {
                  "complaintsVerbatim": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "bottleneck": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "complaintsVerbatim",
                  "bottleneck"
                ],
                "additionalProperties": false
              },
              "proof": {
                "type": "object",
                "properties": {
                  "results": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "client": {
                          "type": "string"
                        },
                        "result": {
                          "type": "string"
                        },
                        "timeframe": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "required": [
                        "client",
                        "result",
                        "timeframe"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "testimonials": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "quote": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "role": {
                          "type": "string",
                          "nullable": true
                        },
                        "imageUrl": {
                          "type": "string",
                          "nullable": true
                        },
                        "media": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "none"
                                  ]
                                }
                              },
                              "required": [
                                "kind"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "object",
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "wistia"
                                  ]
                                },
                                "mediaId": {
                                  "type": "string"
                                },
                                "landerMediaId": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "poster": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "aspect": {
                                  "type": "number"
                                },
                                "autoplay": {
                                  "type": "boolean"
                                }
                              },
                              "required": [
                                "kind",
                                "mediaId",
                                "landerMediaId",
                                "poster",
                                "aspect",
                                "autoplay"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "object",
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "youtube",
                                    "vimeo",
                                    "loom"
                                  ]
                                },
                                "url": {
                                  "type": "string"
                                },
                                "poster": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "aspect": {
                                  "type": "number"
                                },
                                "autoplay": {
                                  "type": "boolean"
                                }
                              },
                              "required": [
                                "kind",
                                "url",
                                "poster",
                                "aspect",
                                "autoplay"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "object",
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "audio"
                                  ]
                                },
                                "url": {
                                  "type": "string"
                                },
                                "caption": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "required": [
                                "kind",
                                "url",
                                "caption"
                              ],
                              "additionalProperties": false
                            },
                            {
                              "type": "object",
                              "properties": {
                                "kind": {
                                  "type": "string",
                                  "enum": [
                                    "image"
                                  ]
                                },
                                "url": {
                                  "type": "string"
                                },
                                "caption": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "required": [
                                "kind",
                                "url",
                                "caption"
                              ],
                              "additionalProperties": false
                            }
                          ]
                        }
                      },
                      "required": [
                        "quote",
                        "name",
                        "role"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "logos": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "rating": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "number"
                      },
                      "count": {
                        "type": "number"
                      },
                      "platform": {
                        "type": "string"
                      },
                      "url": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "required": [
                      "value",
                      "count",
                      "platform",
                      "url"
                    ],
                    "additionalProperties": false,
                    "nullable": true
                  },
                  "yearsOrClients": {
                    "type": "string",
                    "nullable": true
                  },
                  "recordingUrl": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "results",
                  "testimonials",
                  "logos",
                  "rating",
                  "yearsOrClients",
                  "recordingUrl"
                ],
                "additionalProperties": false
              },
              "call": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "minutes": {
                    "type": "number"
                  },
                  "host": {
                    "type": "string"
                  },
                  "hostRole": {
                    "type": "string",
                    "nullable": true
                  },
                  "hostBio": {
                    "type": "string",
                    "nullable": true
                  },
                  "agenda": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "leaveWith": {
                    "type": "string",
                    "nullable": true
                  },
                  "guarantee": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "name",
                  "minutes",
                  "host",
                  "hostRole",
                  "hostBio",
                  "agenda",
                  "leaveWith",
                  "guarantee"
                ],
                "additionalProperties": false
              },
              "compliance": {
                "type": "object",
                "properties": {
                  "neverSay": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "flags": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "hipaa",
                        "tcpa",
                        "financial"
                      ]
                    }
                  }
                },
                "required": [
                  "neverSay",
                  "flags"
                ],
                "additionalProperties": false
              },
              "video": {
                "type": "object",
                "properties": {
                  "has": {
                    "type": "boolean"
                  },
                  "url": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "has",
                  "url"
                ],
                "additionalProperties": false
              },
              "traffic": {
                "type": "string",
                "enum": [
                  "cold_ads",
                  "warm_outbound",
                  "organic",
                  "mixed"
                ]
              },
              "vibe": {
                "type": "string",
                "enum": [
                  "bold",
                  "dark",
                  "clean",
                  "friendly"
                ]
              },
              "preset": {
                "type": "string",
                "enum": [
                  "case_study",
                  "vsl_demo",
                  "quiz_first",
                  "sales_letter"
                ]
              },
              "questionCount": {
                "type": "number",
                "nullable": true
              }
            },
            "required": [
              "offer",
              "audience",
              "pain",
              "proof",
              "call",
              "compliance",
              "video",
              "traffic",
              "vibe",
              "preset",
              "questionCount"
            ],
            "additionalProperties": false
          },
          "page": {
            "type": "object",
            "properties": {
              "version": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "funnel": {
                "type": "object",
                "properties": {
                  "entry": {
                    "type": "string",
                    "enum": [
                      "optin",
                      "apply",
                      "inlineBooking"
                    ]
                  },
                  "preset": {
                    "type": "string",
                    "enum": [
                      "case_study",
                      "vsl_demo",
                      "quiz_first",
                      "sales_letter"
                    ]
                  }
                },
                "required": [
                  "entry",
                  "preset"
                ],
                "additionalProperties": false
              },
              "theme": {
                "type": "object",
                "properties": {
                  "mode": {
                    "type": "string",
                    "enum": [
                      "light",
                      "dark"
                    ]
                  },
                  "fontFamily": {
                    "type": "string",
                    "enum": [
                      "inter",
                      "roboto",
                      "poppins",
                      "manrope",
                      "dm-sans",
                      "plus-jakarta"
                    ]
                  },
                  "background": {
                    "type": "string"
                  },
                  "foreground": {
                    "type": "string"
                  },
                  "primary": {
                    "type": "string"
                  },
                  "accent": {
                    "type": "string"
                  },
                  "card": {
                    "type": "string"
                  },
                  "muted": {
                    "type": "string"
                  },
                  "starColor": {
                    "type": "string"
                  },
                  "radius": {
                    "type": "string",
                    "enum": [
                      "small",
                      "medium",
                      "large"
                    ]
                  },
                  "heroStyle": {
                    "type": "string",
                    "enum": [
                      "image",
                      "dark",
                      "clean",
                      "gradient"
                    ]
                  },
                  "heroImageUrl": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "mode",
                  "fontFamily",
                  "background",
                  "foreground",
                  "primary",
                  "accent",
                  "card",
                  "muted",
                  "starColor",
                  "radius",
                  "heroStyle",
                  "heroImageUrl"
                ],
                "additionalProperties": false
              },
              "header": {
                "type": "object",
                "properties": {
                  "showLogo": {
                    "type": "boolean"
                  },
                  "logoUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "ctaLabel": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "showLogo",
                  "logoUrl",
                  "name",
                  "ctaLabel"
                ],
                "additionalProperties": false
              },
              "cta": {
                "type": "object",
                "properties": {
                  "label": {
                    "type": "string"
                  },
                  "sub": {
                    "type": "string",
                    "nullable": true
                  },
                  "mode": {
                    "type": "string",
                    "enum": [
                      "persistent",
                      "delayed"
                    ]
                  },
                  "revealAtSeconds": {
                    "type": "number"
                  },
                  "softLabel": {
                    "type": "string",
                    "nullable": true
                  },
                  "trustLine": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "label",
                  "sub",
                  "mode",
                  "revealAtSeconds",
                  "softLabel",
                  "trustLine"
                ],
                "additionalProperties": false
              },
              "video": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "none"
                        ]
                      }
                    },
                    "required": [
                      "kind"
                    ],
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "wistia"
                        ]
                      },
                      "mediaId": {
                        "type": "string"
                      },
                      "landerMediaId": {
                        "type": "string",
                        "nullable": true
                      },
                      "poster": {
                        "type": "string",
                        "nullable": true
                      },
                      "aspect": {
                        "type": "number"
                      },
                      "autoplay": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "kind",
                      "mediaId",
                      "landerMediaId",
                      "poster",
                      "aspect",
                      "autoplay"
                    ],
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "youtube",
                          "vimeo",
                          "loom"
                        ]
                      },
                      "url": {
                        "type": "string"
                      },
                      "poster": {
                        "type": "string",
                        "nullable": true
                      },
                      "aspect": {
                        "type": "number"
                      },
                      "autoplay": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "kind",
                      "url",
                      "poster",
                      "aspect",
                      "autoplay"
                    ],
                    "additionalProperties": false
                  }
                ]
              },
              "proof": {
                "type": "object",
                "properties": {
                  "rating": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "number"
                      },
                      "count": {
                        "type": "number"
                      },
                      "platform": {
                        "type": "string",
                        "nullable": true
                      },
                      "url": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "required": [
                      "value",
                      "count",
                      "platform",
                      "url"
                    ],
                    "additionalProperties": false,
                    "nullable": true
                  },
                  "logos": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "imageUrl": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "required": [
                        "name",
                        "imageUrl"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "rating",
                  "logos"
                ],
                "additionalProperties": false
              },
              "hero": {
                "type": "object",
                "properties": {
                  "eyebrow": {
                    "type": "string",
                    "nullable": true
                  },
                  "eyebrowHighlight": {
                    "type": "boolean"
                  },
                  "headline": {
                    "type": "string"
                  },
                  "headlineFormula": {
                    "type": "string",
                    "enum": [
                      "A",
                      "B",
                      "C",
                      "D"
                    ]
                  },
                  "subheadline": {
                    "type": "string",
                    "nullable": true
                  },
                  "disarmLine": {
                    "type": "string",
                    "nullable": true
                  },
                  "valueAnchor": {
                    "type": "string",
                    "nullable": true
                  },
                  "showVideo": {
                    "type": "boolean"
                  },
                  "captionLine": {
                    "type": "string",
                    "nullable": true
                  },
                  "mockupImageUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "inlineQuestionKey": {
                    "type": "string",
                    "nullable": true
                  },
                  "showRating": {
                    "type": "boolean"
                  },
                  "showLogos": {
                    "type": "boolean"
                  },
                  "scrollCue": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "eyebrow",
                  "eyebrowHighlight",
                  "headline",
                  "headlineFormula",
                  "subheadline",
                  "disarmLine",
                  "valueAnchor",
                  "showVideo",
                  "captionLine",
                  "mockupImageUrl",
                  "inlineQuestionKey",
                  "showRating",
                  "showLogos",
                  "scrollCue"
                ],
                "additionalProperties": false
              },
              "sections": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "faq",
                        "urgency",
                        "confirm",
                        "notFor",
                        "pain",
                        "logos",
                        "agenda",
                        "bridge",
                        "mechanism",
                        "proofItems",
                        "benefits",
                        "callPitch",
                        "bookingInline",
                        "letter",
                        "fascinations",
                        "steps",
                        "founder",
                        "authority",
                        "closing",
                        "nextSteps",
                        "prepVideo",
                        "prepare",
                        "team",
                        "caseStudies",
                        "bonus",
                        "signoff"
                      ]
                    },
                    "enabled": {
                      "type": "boolean"
                    },
                    "data": {
                      "type": "object",
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "id",
                    "type",
                    "enabled",
                    "data"
                  ],
                  "additionalProperties": false
                }
              },
              "watch": {
                "type": "object",
                "properties": {
                  "headline": {
                    "type": "string"
                  },
                  "sub": {
                    "type": "string",
                    "nullable": true
                  },
                  "video": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "none"
                            ]
                          }
                        },
                        "required": [
                          "kind"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "wistia"
                            ]
                          },
                          "mediaId": {
                            "type": "string"
                          },
                          "landerMediaId": {
                            "type": "string",
                            "nullable": true
                          },
                          "poster": {
                            "type": "string",
                            "nullable": true
                          },
                          "aspect": {
                            "type": "number"
                          },
                          "autoplay": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "kind",
                          "mediaId",
                          "landerMediaId",
                          "poster",
                          "aspect",
                          "autoplay"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "youtube",
                              "vimeo",
                              "loom"
                            ]
                          },
                          "url": {
                            "type": "string"
                          },
                          "poster": {
                            "type": "string",
                            "nullable": true
                          },
                          "aspect": {
                            "type": "number"
                          },
                          "autoplay": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "kind",
                          "url",
                          "poster",
                          "aspect",
                          "autoplay"
                        ],
                        "additionalProperties": false
                      }
                    ]
                  },
                  "ctaSub": {
                    "type": "string",
                    "nullable": true
                  },
                  "valueAnchor": {
                    "type": "string",
                    "nullable": true
                  },
                  "showRating": {
                    "type": "boolean"
                  },
                  "showLogos": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "headline",
                  "sub",
                  "video",
                  "ctaSub",
                  "valueAnchor",
                  "showRating",
                  "showLogos"
                ],
                "additionalProperties": false
              },
              "form": {
                "type": "object",
                "properties": {
                  "intro": {
                    "type": "object",
                    "properties": {
                      "eyebrow": {
                        "type": "string",
                        "nullable": true
                      },
                      "headline": {
                        "type": "string"
                      },
                      "sub": {
                        "type": "string",
                        "nullable": true
                      },
                      "showRating": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "eyebrow",
                      "headline",
                      "sub",
                      "showRating"
                    ],
                    "additionalProperties": false
                  },
                  "contactPosition": {
                    "type": "string",
                    "enum": [
                      "last",
                      "first"
                    ]
                  },
                  "steps": {
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "multiple": {
                              "type": "boolean"
                            },
                            "visual": {
                              "type": "string",
                              "enum": [
                                "list",
                                "tiles"
                              ]
                            },
                            "options": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "key": {
                                    "type": "string"
                                  },
                                  "label": {
                                    "type": "string"
                                  },
                                  "emoji": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "imageUrl": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "weight": {
                                    "anyOf": [
                                      {
                                        "type": "number",
                                        "enum": [
                                          0
                                        ]
                                      },
                                      {
                                        "type": "number",
                                        "enum": [
                                          1
                                        ]
                                      },
                                      {
                                        "type": "number",
                                        "enum": [
                                          2
                                        ]
                                      },
                                      {
                                        "type": "string",
                                        "enum": [
                                          "dq"
                                        ]
                                      },
                                      {
                                        "type": "number",
                                        "enum": [
                                          3
                                        ]
                                      }
                                    ]
                                  }
                                },
                                "required": [
                                  "key",
                                  "label",
                                  "emoji",
                                  "imageUrl",
                                  "weight"
                                ],
                                "additionalProperties": false
                              }
                            },
                            "key": {
                              "type": "string"
                            },
                            "label": {
                              "type": "string"
                            },
                            "stepLabel": {
                              "type": "string",
                              "nullable": true
                            },
                            "prompt": {
                              "type": "string"
                            },
                            "reasonWhy": {
                              "type": "string",
                              "nullable": true
                            },
                            "kind": {
                              "type": "string",
                              "enum": [
                                "choice"
                              ]
                            }
                          },
                          "required": [
                            "multiple",
                            "visual",
                            "options",
                            "key",
                            "label",
                            "stepLabel",
                            "prompt",
                            "reasonWhy",
                            "kind"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "object",
                          "properties": {
                            "inputType": {
                              "type": "string",
                              "enum": [
                                "number",
                                "text",
                                "textarea",
                                "url",
                                "select"
                              ]
                            },
                            "options": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "placeholder": {
                              "type": "string",
                              "nullable": true
                            },
                            "required": {
                              "type": "boolean"
                            },
                            "key": {
                              "type": "string"
                            },
                            "label": {
                              "type": "string"
                            },
                            "stepLabel": {
                              "type": "string",
                              "nullable": true
                            },
                            "prompt": {
                              "type": "string"
                            },
                            "reasonWhy": {
                              "type": "string",
                              "nullable": true
                            },
                            "kind": {
                              "type": "string",
                              "enum": [
                                "input"
                              ]
                            }
                          },
                          "required": [
                            "inputType",
                            "options",
                            "placeholder",
                            "required",
                            "key",
                            "label",
                            "stepLabel",
                            "prompt",
                            "reasonWhy",
                            "kind"
                          ],
                          "additionalProperties": false
                        }
                      ]
                    }
                  },
                  "contact": {
                    "type": "object",
                    "properties": {
                      "fields": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "enum": [
                            "name",
                            "phone",
                            "company"
                          ]
                        }
                      },
                      "required": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "enum": [
                            "name",
                            "phone",
                            "company"
                          ]
                        }
                      },
                      "consentText": {
                        "type": "string"
                      },
                      "submitLabel": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "fields",
                      "required",
                      "consentText",
                      "submitLabel"
                    ],
                    "additionalProperties": false
                  },
                  "commitment": {
                    "type": "object",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "prompt": {
                        "type": "string"
                      },
                      "yesLabel": {
                        "type": "string"
                      },
                      "noLabel": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "enabled",
                      "prompt",
                      "yesLabel",
                      "noLabel"
                    ],
                    "additionalProperties": false
                  },
                  "verifying": {
                    "type": "object",
                    "properties": {
                      "enabled": {
                        "type": "boolean"
                      },
                      "lines": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "seconds": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "enabled",
                      "lines",
                      "seconds"
                    ],
                    "additionalProperties": false
                  },
                  "scoring": {
                    "type": "object",
                    "properties": {
                      "threshold": {
                        "type": "number"
                      },
                      "maxScore": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "threshold",
                      "maxScore"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "intro",
                  "contactPosition",
                  "steps",
                  "contact",
                  "commitment",
                  "verifying",
                  "scoring"
                ],
                "additionalProperties": false
              },
              "booking": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "nullable": true
                  },
                  "provider": {
                    "type": "string",
                    "enum": [
                      "link",
                      "google",
                      "auto",
                      "calendly",
                      "cal_com",
                      "gohighlevel",
                      "hubspot",
                      "tidycal",
                      "acuity",
                      "zoho",
                      "youcanbookme",
                      "savvycal",
                      "microsoft"
                    ]
                  },
                  "mode": {
                    "type": "string",
                    "enum": [
                      "inline",
                      "newTab"
                    ]
                  },
                  "headline": {
                    "type": "string"
                  },
                  "sub": {
                    "type": "string",
                    "nullable": true
                  },
                  "bullets": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "hostName": {
                    "type": "string",
                    "nullable": true
                  },
                  "minutes": {
                    "type": "number",
                    "nullable": true
                  },
                  "noFitLine": {
                    "type": "string",
                    "nullable": true
                  },
                  "scarcity": {
                    "type": "string",
                    "nullable": true
                  },
                  "prefill": {
                    "type": "boolean"
                  },
                  "passAnswers": {
                    "type": "boolean"
                  },
                  "continueLabel": {
                    "type": "string"
                  },
                  "showRating": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "url",
                  "provider",
                  "mode",
                  "headline",
                  "sub",
                  "bullets",
                  "hostName",
                  "minutes",
                  "noFitLine",
                  "scarcity",
                  "prefill",
                  "passAnswers",
                  "continueLabel",
                  "showRating"
                ],
                "additionalProperties": false
              },
              "thankYou": {
                "type": "object",
                "properties": {
                  "sections": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "faq",
                            "urgency",
                            "confirm",
                            "notFor",
                            "pain",
                            "logos",
                            "agenda",
                            "bridge",
                            "mechanism",
                            "proofItems",
                            "benefits",
                            "callPitch",
                            "bookingInline",
                            "letter",
                            "fascinations",
                            "steps",
                            "founder",
                            "authority",
                            "closing",
                            "nextSteps",
                            "prepVideo",
                            "prepare",
                            "team",
                            "caseStudies",
                            "bonus",
                            "signoff"
                          ]
                        },
                        "enabled": {
                          "type": "boolean"
                        },
                        "data": {
                          "type": "object",
                          "additionalProperties": {}
                        }
                      },
                      "required": [
                        "id",
                        "type",
                        "enabled",
                        "data"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "showAddToCalendar": {
                    "type": "boolean"
                  },
                  "showConfirmAttendance": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "sections",
                  "showAddToCalendar",
                  "showConfirmAttendance"
                ],
                "additionalProperties": false
              },
              "notFit": {
                "type": "object",
                "properties": {
                  "headline": {
                    "type": "string"
                  },
                  "body": {
                    "type": "string"
                  },
                  "reapplyWhen": {
                    "type": "string",
                    "nullable": true
                  },
                  "resourceLabel": {
                    "type": "string",
                    "nullable": true
                  },
                  "resourceUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "showRating": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "headline",
                  "body",
                  "reapplyWhen",
                  "resourceLabel",
                  "resourceUrl",
                  "showRating"
                ],
                "additionalProperties": false
              },
              "legal": {
                "type": "object",
                "properties": {
                  "companyLine": {
                    "type": "string"
                  },
                  "platformDisclaimer": {
                    "type": "boolean"
                  },
                  "earningsDisclaimer": {
                    "type": "boolean"
                  },
                  "privacyUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "termsUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "privacyText": {
                    "type": "string",
                    "nullable": true
                  },
                  "termsText": {
                    "type": "string",
                    "nullable": true
                  },
                  "footerNote": {
                    "type": "string",
                    "nullable": true
                  },
                  "sources": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "companyLine",
                  "platformDisclaimer",
                  "earningsDisclaimer",
                  "privacyUrl",
                  "termsUrl",
                  "privacyText",
                  "termsText",
                  "footerNote",
                  "sources"
                ],
                "additionalProperties": false
              },
              "seo": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "ogImageUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "indexable": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "title",
                  "description",
                  "ogImageUrl",
                  "indexable"
                ],
                "additionalProperties": false
              },
              "tracking": {
                "type": "object",
                "properties": {
                  "metaPixelId": {
                    "type": "string",
                    "nullable": true
                  },
                  "ga4MeasurementId": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "metaPixelId",
                  "ga4MeasurementId"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "version",
              "funnel",
              "theme",
              "header",
              "cta",
              "video",
              "proof",
              "hero",
              "sections",
              "watch",
              "form",
              "booking",
              "thankYou",
              "notFit",
              "legal",
              "seo",
              "tracking"
            ],
            "additionalProperties": false
          },
          "scripts": {
            "type": "object",
            "properties": {
              "vsl": {
                "type": "object",
                "properties": {
                  "beats": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "enum": [
                            "faq",
                            "cta",
                            "offer",
                            "proof",
                            "guarantee",
                            "mechanism",
                            "hook",
                            "callout",
                            "problem",
                            "mistakes"
                          ]
                        },
                        "text": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "name",
                        "text"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "wordCount": {
                    "type": "number"
                  },
                  "targetMinutes": {
                    "type": "number"
                  }
                },
                "required": [
                  "beats",
                  "wordCount",
                  "targetMinutes"
                ],
                "additionalProperties": false,
                "nullable": true
              },
              "prep": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "wordCount": {
                    "type": "number"
                  }
                },
                "required": [
                  "text",
                  "wordCount"
                ],
                "additionalProperties": false,
                "nullable": true
              },
              "demo": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "wordCount": {
                    "type": "number"
                  }
                },
                "required": [
                  "text",
                  "wordCount"
                ],
                "additionalProperties": false,
                "nullable": true
              }
            },
            "required": [
              "vsl",
              "prep",
              "demo"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "agency_id",
          "name",
          "slug",
          "status",
          "niche_id",
          "published_at",
          "generation_count",
          "last_generated_at",
          "created_by",
          "created_at",
          "updated_at",
          "url",
          "facts",
          "page",
          "scripts"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/landers/{lander_id}Get one landing page with its parsed document

Get one landing page with its parsed document

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "published",
        "archived"
      ]
    },
    "niche_id": {
      "type": "string",
      "nullable": true
    },
    "published_at": {
      "type": "string",
      "nullable": true
    },
    "generation_count": {
      "type": "number"
    },
    "last_generated_at": {
      "type": "string",
      "nullable": true
    },
    "created_by": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "nullable": true
    },
    "facts": {
      "type": "object",
      "properties": {
        "offer": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "whatItDoes": {
              "type": "string"
            },
            "deliverables": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "mechanismName": {
              "type": "string",
              "nullable": true
            },
            "integrations": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "goLiveDays": {
              "type": "number",
              "nullable": true
            },
            "priceFrame": {
              "type": "string",
              "nullable": true
            },
            "capacityPerMonth": {
              "type": "number",
              "nullable": true
            },
            "leadMagnet": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "whatItIs": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "whatItIs"
              ],
              "additionalProperties": false,
              "nullable": true
            }
          },
          "required": [
            "name",
            "whatItDoes",
            "deliverables",
            "mechanismName",
            "integrations",
            "goLiveDays",
            "priceFrame",
            "capacityPerMonth",
            "leadMagnet"
          ],
          "additionalProperties": false
        },
        "audience": {
          "type": "object",
          "properties": {
            "nicheSlug": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string"
            },
            "revenueBand": {
              "type": "string",
              "nullable": true
            },
            "region": {
              "type": "string",
              "nullable": true
            },
            "notFor": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "nicheSlug",
            "description",
            "revenueBand",
            "region",
            "notFor"
          ],
          "additionalProperties": false
        },
        "pain": {
          "type": "object",
          "properties": {
            "complaintsVerbatim": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "bottleneck": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "complaintsVerbatim",
            "bottleneck"
          ],
          "additionalProperties": false
        },
        "proof": {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "client": {
                    "type": "string"
                  },
                  "result": {
                    "type": "string"
                  },
                  "timeframe": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "client",
                  "result",
                  "timeframe"
                ],
                "additionalProperties": false
              }
            },
            "testimonials": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "quote": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "role": {
                    "type": "string",
                    "nullable": true
                  },
                  "imageUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "media": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "none"
                            ]
                          }
                        },
                        "required": [
                          "kind"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "wistia"
                            ]
                          },
                          "mediaId": {
                            "type": "string"
                          },
                          "landerMediaId": {
                            "type": "string",
                            "nullable": true
                          },
                          "poster": {
                            "type": "string",
                            "nullable": true
                          },
                          "aspect": {
                            "type": "number"
                          },
                          "autoplay": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "kind",
                          "mediaId",
                          "landerMediaId",
                          "poster",
                          "aspect",
                          "autoplay"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "youtube",
                              "vimeo",
                              "loom"
                            ]
                          },
                          "url": {
                            "type": "string"
                          },
                          "poster": {
                            "type": "string",
                            "nullable": true
                          },
                          "aspect": {
                            "type": "number"
                          },
                          "autoplay": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "kind",
                          "url",
                          "poster",
                          "aspect",
                          "autoplay"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "audio"
                            ]
                          },
                          "url": {
                            "type": "string"
                          },
                          "caption": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "required": [
                          "kind",
                          "url",
                          "caption"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "image"
                            ]
                          },
                          "url": {
                            "type": "string"
                          },
                          "caption": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "required": [
                          "kind",
                          "url",
                          "caption"
                        ],
                        "additionalProperties": false
                      }
                    ]
                  }
                },
                "required": [
                  "quote",
                  "name",
                  "role"
                ],
                "additionalProperties": false
              }
            },
            "logos": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "rating": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "number"
                },
                "count": {
                  "type": "number"
                },
                "platform": {
                  "type": "string"
                },
                "url": {
                  "type": "string",
                  "nullable": true
                }
              },
              "required": [
                "value",
                "count",
                "platform",
                "url"
              ],
              "additionalProperties": false,
              "nullable": true
            },
            "yearsOrClients": {
              "type": "string",
              "nullable": true
            },
            "recordingUrl": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "results",
            "testimonials",
            "logos",
            "rating",
            "yearsOrClients",
            "recordingUrl"
          ],
          "additionalProperties": false
        },
        "call": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "minutes": {
              "type": "number"
            },
            "host": {
              "type": "string"
            },
            "hostRole": {
              "type": "string",
              "nullable": true
            },
            "hostBio": {
              "type": "string",
              "nullable": true
            },
            "agenda": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "leaveWith": {
              "type": "string",
              "nullable": true
            },
            "guarantee": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "name",
            "minutes",
            "host",
            "hostRole",
            "hostBio",
            "agenda",
            "leaveWith",
            "guarantee"
          ],
          "additionalProperties": false
        },
        "compliance": {
          "type": "object",
          "properties": {
            "neverSay": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "flags": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "hipaa",
                  "tcpa",
                  "financial"
                ]
              }
            }
          },
          "required": [
            "neverSay",
            "flags"
          ],
          "additionalProperties": false
        },
        "video": {
          "type": "object",
          "properties": {
            "has": {
              "type": "boolean"
            },
            "url": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "has",
            "url"
          ],
          "additionalProperties": false
        },
        "traffic": {
          "type": "string",
          "enum": [
            "cold_ads",
            "warm_outbound",
            "organic",
            "mixed"
          ]
        },
        "vibe": {
          "type": "string",
          "enum": [
            "bold",
            "dark",
            "clean",
            "friendly"
          ]
        },
        "preset": {
          "type": "string",
          "enum": [
            "case_study",
            "vsl_demo",
            "quiz_first",
            "sales_letter"
          ]
        },
        "questionCount": {
          "type": "number",
          "nullable": true
        }
      },
      "required": [
        "offer",
        "audience",
        "pain",
        "proof",
        "call",
        "compliance",
        "video",
        "traffic",
        "vibe",
        "preset",
        "questionCount"
      ],
      "additionalProperties": false
    },
    "page": {
      "type": "object",
      "properties": {
        "version": {
          "type": "number",
          "enum": [
            1
          ]
        },
        "funnel": {
          "type": "object",
          "properties": {
            "entry": {
              "type": "string",
              "enum": [
                "optin",
                "apply",
                "inlineBooking"
              ]
            },
            "preset": {
              "type": "string",
              "enum": [
                "case_study",
                "vsl_demo",
                "quiz_first",
                "sales_letter"
              ]
            }
          },
          "required": [
            "entry",
            "preset"
          ],
          "additionalProperties": false
        },
        "theme": {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "light",
                "dark"
              ]
            },
            "fontFamily": {
              "type": "string",
              "enum": [
                "inter",
                "roboto",
                "poppins",
                "manrope",
                "dm-sans",
                "plus-jakarta"
              ]
            },
            "background": {
              "type": "string"
            },
            "foreground": {
              "type": "string"
            },
            "primary": {
              "type": "string"
            },
            "accent": {
              "type": "string"
            },
            "card": {
              "type": "string"
            },
            "muted": {
              "type": "string"
            },
            "starColor": {
              "type": "string"
            },
            "radius": {
              "type": "string",
              "enum": [
                "small",
                "medium",
                "large"
              ]
            },
            "heroStyle": {
              "type": "string",
              "enum": [
                "image",
                "dark",
                "clean",
                "gradient"
              ]
            },
            "heroImageUrl": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "mode",
            "fontFamily",
            "background",
            "foreground",
            "primary",
            "accent",
            "card",
            "muted",
            "starColor",
            "radius",
            "heroStyle",
            "heroImageUrl"
          ],
          "additionalProperties": false
        },
        "header": {
          "type": "object",
          "properties": {
            "showLogo": {
              "type": "boolean"
            },
            "logoUrl": {
              "type": "string",
              "nullable": true
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "ctaLabel": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "showLogo",
            "logoUrl",
            "name",
            "ctaLabel"
          ],
          "additionalProperties": false
        },
        "cta": {
          "type": "object",
          "properties": {
            "label": {
              "type": "string"
            },
            "sub": {
              "type": "string",
              "nullable": true
            },
            "mode": {
              "type": "string",
              "enum": [
                "persistent",
                "delayed"
              ]
            },
            "revealAtSeconds": {
              "type": "number"
            },
            "softLabel": {
              "type": "string",
              "nullable": true
            },
            "trustLine": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "label",
            "sub",
            "mode",
            "revealAtSeconds",
            "softLabel",
            "trustLine"
          ],
          "additionalProperties": false
        },
        "video": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "none"
                  ]
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "wistia"
                  ]
                },
                "mediaId": {
                  "type": "string"
                },
                "landerMediaId": {
                  "type": "string",
                  "nullable": true
                },
                "poster": {
                  "type": "string",
                  "nullable": true
                },
                "aspect": {
                  "type": "number"
                },
                "autoplay": {
                  "type": "boolean"
                }
              },
              "required": [
                "kind",
                "mediaId",
                "landerMediaId",
                "poster",
                "aspect",
                "autoplay"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "youtube",
                    "vimeo",
                    "loom"
                  ]
                },
                "url": {
                  "type": "string"
                },
                "poster": {
                  "type": "string",
                  "nullable": true
                },
                "aspect": {
                  "type": "number"
                },
                "autoplay": {
                  "type": "boolean"
                }
              },
              "required": [
                "kind",
                "url",
                "poster",
                "aspect",
                "autoplay"
              ],
              "additionalProperties": false
            }
          ]
        },
        "proof": {
          "type": "object",
          "properties": {
            "rating": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "number"
                },
                "count": {
                  "type": "number"
                },
                "platform": {
                  "type": "string",
                  "nullable": true
                },
                "url": {
                  "type": "string",
                  "nullable": true
                }
              },
              "required": [
                "value",
                "count",
                "platform",
                "url"
              ],
              "additionalProperties": false,
              "nullable": true
            },
            "logos": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "imageUrl": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "name",
                  "imageUrl"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "rating",
            "logos"
          ],
          "additionalProperties": false
        },
        "hero": {
          "type": "object",
          "properties": {
            "eyebrow": {
              "type": "string",
              "nullable": true
            },
            "eyebrowHighlight": {
              "type": "boolean"
            },
            "headline": {
              "type": "string"
            },
            "headlineFormula": {
              "type": "string",
              "enum": [
                "A",
                "B",
                "C",
                "D"
              ]
            },
            "subheadline": {
              "type": "string",
              "nullable": true
            },
            "disarmLine": {
              "type": "string",
              "nullable": true
            },
            "valueAnchor": {
              "type": "string",
              "nullable": true
            },
            "showVideo": {
              "type": "boolean"
            },
            "captionLine": {
              "type": "string",
              "nullable": true
            },
            "mockupImageUrl": {
              "type": "string",
              "nullable": true
            },
            "inlineQuestionKey": {
              "type": "string",
              "nullable": true
            },
            "showRating": {
              "type": "boolean"
            },
            "showLogos": {
              "type": "boolean"
            },
            "scrollCue": {
              "type": "boolean"
            }
          },
          "required": [
            "eyebrow",
            "eyebrowHighlight",
            "headline",
            "headlineFormula",
            "subheadline",
            "disarmLine",
            "valueAnchor",
            "showVideo",
            "captionLine",
            "mockupImageUrl",
            "inlineQuestionKey",
            "showRating",
            "showLogos",
            "scrollCue"
          ],
          "additionalProperties": false
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "faq",
                  "urgency",
                  "confirm",
                  "notFor",
                  "pain",
                  "logos",
                  "agenda",
                  "bridge",
                  "mechanism",
                  "proofItems",
                  "benefits",
                  "callPitch",
                  "bookingInline",
                  "letter",
                  "fascinations",
                  "steps",
                  "founder",
                  "authority",
                  "closing",
                  "nextSteps",
                  "prepVideo",
                  "prepare",
                  "team",
                  "caseStudies",
                  "bonus",
                  "signoff"
                ]
              },
              "enabled": {
                "type": "boolean"
              },
              "data": {
                "type": "object",
                "additionalProperties": {}
              }
            },
            "required": [
              "id",
              "type",
              "enabled",
              "data"
            ],
            "additionalProperties": false
          }
        },
        "watch": {
          "type": "object",
          "properties": {
            "headline": {
              "type": "string"
            },
            "sub": {
              "type": "string",
              "nullable": true
            },
            "video": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "none"
                      ]
                    }
                  },
                  "required": [
                    "kind"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "wistia"
                      ]
                    },
                    "mediaId": {
                      "type": "string"
                    },
                    "landerMediaId": {
                      "type": "string",
                      "nullable": true
                    },
                    "poster": {
                      "type": "string",
                      "nullable": true
                    },
                    "aspect": {
                      "type": "number"
                    },
                    "autoplay": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "kind",
                    "mediaId",
                    "landerMediaId",
                    "poster",
                    "aspect",
                    "autoplay"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "youtube",
                        "vimeo",
                        "loom"
                      ]
                    },
                    "url": {
                      "type": "string"
                    },
                    "poster": {
                      "type": "string",
                      "nullable": true
                    },
                    "aspect": {
                      "type": "number"
                    },
                    "autoplay": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "kind",
                    "url",
                    "poster",
                    "aspect",
                    "autoplay"
                  ],
                  "additionalProperties": false
                }
              ]
            },
            "ctaSub": {
              "type": "string",
              "nullable": true
            },
            "valueAnchor": {
              "type": "string",
              "nullable": true
            },
            "showRating": {
              "type": "boolean"
            },
            "showLogos": {
              "type": "boolean"
            }
          },
          "required": [
            "headline",
            "sub",
            "video",
            "ctaSub",
            "valueAnchor",
            "showRating",
            "showLogos"
          ],
          "additionalProperties": false
        },
        "form": {
          "type": "object",
          "properties": {
            "intro": {
              "type": "object",
              "properties": {
                "eyebrow": {
                  "type": "string",
                  "nullable": true
                },
                "headline": {
                  "type": "string"
                },
                "sub": {
                  "type": "string",
                  "nullable": true
                },
                "showRating": {
                  "type": "boolean"
                }
              },
              "required": [
                "eyebrow",
                "headline",
                "sub",
                "showRating"
              ],
              "additionalProperties": false
            },
            "contactPosition": {
              "type": "string",
              "enum": [
                "last",
                "first"
              ]
            },
            "steps": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "multiple": {
                        "type": "boolean"
                      },
                      "visual": {
                        "type": "string",
                        "enum": [
                          "list",
                          "tiles"
                        ]
                      },
                      "options": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "key": {
                              "type": "string"
                            },
                            "label": {
                              "type": "string"
                            },
                            "emoji": {
                              "type": "string",
                              "nullable": true
                            },
                            "imageUrl": {
                              "type": "string",
                              "nullable": true
                            },
                            "weight": {
                              "anyOf": [
                                {
                                  "type": "number",
                                  "enum": [
                                    0
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    1
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    2
                                  ]
                                },
                                {
                                  "type": "string",
                                  "enum": [
                                    "dq"
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    3
                                  ]
                                }
                              ]
                            }
                          },
                          "required": [
                            "key",
                            "label",
                            "emoji",
                            "imageUrl",
                            "weight"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "key": {
                        "type": "string"
                      },
                      "label": {
                        "type": "string"
                      },
                      "stepLabel": {
                        "type": "string",
                        "nullable": true
                      },
                      "prompt": {
                        "type": "string"
                      },
                      "reasonWhy": {
                        "type": "string",
                        "nullable": true
                      },
                      "kind": {
                        "type": "string",
                        "enum": [
                          "choice"
                        ]
                      }
                    },
                    "required": [
                      "multiple",
                      "visual",
                      "options",
                      "key",
                      "label",
                      "stepLabel",
                      "prompt",
                      "reasonWhy",
                      "kind"
                    ],
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "properties": {
                      "inputType": {
                        "type": "string",
                        "enum": [
                          "number",
                          "text",
                          "textarea",
                          "url",
                          "select"
                        ]
                      },
                      "options": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "placeholder": {
                        "type": "string",
                        "nullable": true
                      },
                      "required": {
                        "type": "boolean"
                      },
                      "key": {
                        "type": "string"
                      },
                      "label": {
                        "type": "string"
                      },
                      "stepLabel": {
                        "type": "string",
                        "nullable": true
                      },
                      "prompt": {
                        "type": "string"
                      },
                      "reasonWhy": {
                        "type": "string",
                        "nullable": true
                      },
                      "kind": {
                        "type": "string",
                        "enum": [
                          "input"
                        ]
                      }
                    },
                    "required": [
                      "inputType",
                      "options",
                      "placeholder",
                      "required",
                      "key",
                      "label",
                      "stepLabel",
                      "prompt",
                      "reasonWhy",
                      "kind"
                    ],
                    "additionalProperties": false
                  }
                ]
              }
            },
            "contact": {
              "type": "object",
              "properties": {
                "fields": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "name",
                      "phone",
                      "company"
                    ]
                  }
                },
                "required": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "name",
                      "phone",
                      "company"
                    ]
                  }
                },
                "consentText": {
                  "type": "string"
                },
                "submitLabel": {
                  "type": "string"
                }
              },
              "required": [
                "fields",
                "required",
                "consentText",
                "submitLabel"
              ],
              "additionalProperties": false
            },
            "commitment": {
              "type": "object",
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "prompt": {
                  "type": "string"
                },
                "yesLabel": {
                  "type": "string"
                },
                "noLabel": {
                  "type": "string"
                }
              },
              "required": [
                "enabled",
                "prompt",
                "yesLabel",
                "noLabel"
              ],
              "additionalProperties": false
            },
            "verifying": {
              "type": "object",
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "lines": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "seconds": {
                  "type": "number"
                }
              },
              "required": [
                "enabled",
                "lines",
                "seconds"
              ],
              "additionalProperties": false
            },
            "scoring": {
              "type": "object",
              "properties": {
                "threshold": {
                  "type": "number"
                },
                "maxScore": {
                  "type": "number"
                }
              },
              "required": [
                "threshold",
                "maxScore"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "intro",
            "contactPosition",
            "steps",
            "contact",
            "commitment",
            "verifying",
            "scoring"
          ],
          "additionalProperties": false
        },
        "booking": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "nullable": true
            },
            "provider": {
              "type": "string",
              "enum": [
                "link",
                "google",
                "auto",
                "calendly",
                "cal_com",
                "gohighlevel",
                "hubspot",
                "tidycal",
                "acuity",
                "zoho",
                "youcanbookme",
                "savvycal",
                "microsoft"
              ]
            },
            "mode": {
              "type": "string",
              "enum": [
                "inline",
                "newTab"
              ]
            },
            "headline": {
              "type": "string"
            },
            "sub": {
              "type": "string",
              "nullable": true
            },
            "bullets": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "hostName": {
              "type": "string",
              "nullable": true
            },
            "minutes": {
              "type": "number",
              "nullable": true
            },
            "noFitLine": {
              "type": "string",
              "nullable": true
            },
            "scarcity": {
              "type": "string",
              "nullable": true
            },
            "prefill": {
              "type": "boolean"
            },
            "passAnswers": {
              "type": "boolean"
            },
            "continueLabel": {
              "type": "string"
            },
            "showRating": {
              "type": "boolean"
            }
          },
          "required": [
            "url",
            "provider",
            "mode",
            "headline",
            "sub",
            "bullets",
            "hostName",
            "minutes",
            "noFitLine",
            "scarcity",
            "prefill",
            "passAnswers",
            "continueLabel",
            "showRating"
          ],
          "additionalProperties": false
        },
        "thankYou": {
          "type": "object",
          "properties": {
            "sections": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "faq",
                      "urgency",
                      "confirm",
                      "notFor",
                      "pain",
                      "logos",
                      "agenda",
                      "bridge",
                      "mechanism",
                      "proofItems",
                      "benefits",
                      "callPitch",
                      "bookingInline",
                      "letter",
                      "fascinations",
                      "steps",
                      "founder",
                      "authority",
                      "closing",
                      "nextSteps",
                      "prepVideo",
                      "prepare",
                      "team",
                      "caseStudies",
                      "bonus",
                      "signoff"
                    ]
                  },
                  "enabled": {
                    "type": "boolean"
                  },
                  "data": {
                    "type": "object",
                    "additionalProperties": {}
                  }
                },
                "required": [
                  "id",
                  "type",
                  "enabled",
                  "data"
                ],
                "additionalProperties": false
              }
            },
            "showAddToCalendar": {
              "type": "boolean"
            },
            "showConfirmAttendance": {
              "type": "boolean"
            }
          },
          "required": [
            "sections",
            "showAddToCalendar",
            "showConfirmAttendance"
          ],
          "additionalProperties": false
        },
        "notFit": {
          "type": "object",
          "properties": {
            "headline": {
              "type": "string"
            },
            "body": {
              "type": "string"
            },
            "reapplyWhen": {
              "type": "string",
              "nullable": true
            },
            "resourceLabel": {
              "type": "string",
              "nullable": true
            },
            "resourceUrl": {
              "type": "string",
              "nullable": true
            },
            "showRating": {
              "type": "boolean"
            }
          },
          "required": [
            "headline",
            "body",
            "reapplyWhen",
            "resourceLabel",
            "resourceUrl",
            "showRating"
          ],
          "additionalProperties": false
        },
        "legal": {
          "type": "object",
          "properties": {
            "companyLine": {
              "type": "string"
            },
            "platformDisclaimer": {
              "type": "boolean"
            },
            "earningsDisclaimer": {
              "type": "boolean"
            },
            "privacyUrl": {
              "type": "string",
              "nullable": true
            },
            "termsUrl": {
              "type": "string",
              "nullable": true
            },
            "privacyText": {
              "type": "string",
              "nullable": true
            },
            "termsText": {
              "type": "string",
              "nullable": true
            },
            "footerNote": {
              "type": "string",
              "nullable": true
            },
            "sources": {
              "type": "boolean"
            }
          },
          "required": [
            "companyLine",
            "platformDisclaimer",
            "earningsDisclaimer",
            "privacyUrl",
            "termsUrl",
            "privacyText",
            "termsText",
            "footerNote",
            "sources"
          ],
          "additionalProperties": false
        },
        "seo": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "ogImageUrl": {
              "type": "string",
              "nullable": true
            },
            "indexable": {
              "type": "boolean"
            }
          },
          "required": [
            "title",
            "description",
            "ogImageUrl",
            "indexable"
          ],
          "additionalProperties": false
        },
        "tracking": {
          "type": "object",
          "properties": {
            "metaPixelId": {
              "type": "string",
              "nullable": true
            },
            "ga4MeasurementId": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "metaPixelId",
            "ga4MeasurementId"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "version",
        "funnel",
        "theme",
        "header",
        "cta",
        "video",
        "proof",
        "hero",
        "sections",
        "watch",
        "form",
        "booking",
        "thankYou",
        "notFit",
        "legal",
        "seo",
        "tracking"
      ],
      "additionalProperties": false
    },
    "scripts": {
      "type": "object",
      "properties": {
        "vsl": {
          "type": "object",
          "properties": {
            "beats": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "enum": [
                      "faq",
                      "cta",
                      "offer",
                      "proof",
                      "guarantee",
                      "mechanism",
                      "hook",
                      "callout",
                      "problem",
                      "mistakes"
                    ]
                  },
                  "text": {
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "text"
                ],
                "additionalProperties": false
              }
            },
            "wordCount": {
              "type": "number"
            },
            "targetMinutes": {
              "type": "number"
            }
          },
          "required": [
            "beats",
            "wordCount",
            "targetMinutes"
          ],
          "additionalProperties": false,
          "nullable": true
        },
        "prep": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            },
            "wordCount": {
              "type": "number"
            }
          },
          "required": [
            "text",
            "wordCount"
          ],
          "additionalProperties": false,
          "nullable": true
        },
        "demo": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            },
            "wordCount": {
              "type": "number"
            }
          },
          "required": [
            "text",
            "wordCount"
          ],
          "additionalProperties": false,
          "nullable": true
        }
      },
      "required": [
        "vsl",
        "prep",
        "demo"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "agency_id",
    "name",
    "slug",
    "status",
    "niche_id",
    "published_at",
    "generation_count",
    "last_generated_at",
    "created_by",
    "created_at",
    "updated_at",
    "url",
    "facts",
    "page",
    "scripts"
  ],
  "additionalProperties": false
}
POST /api/v1/landersCreate a landing page from its facts

Creates the standard VSL layout from a complete brief and required agency footer policies. Generate the copy by posting to its generations resource.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "nicheId": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    },
    "facts": {
      "type": "object",
      "properties": {
        "offer": {
          "default": {},
          "type": "object",
          "properties": {
            "name": {
              "default": "",
              "type": "string",
              "maxLength": 120
            },
            "whatItDoes": {
              "default": "",
              "type": "string",
              "maxLength": 600
            },
            "deliverables": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 200
              }
            },
            "mechanismName": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "integrations": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 60
              }
            },
            "goLiveDays": {
              "default": null,
              "nullable": true,
              "type": "integer",
              "minimum": 0,
              "maximum": 365
            },
            "priceFrame": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 120
            },
            "capacityPerMonth": {
              "default": null,
              "nullable": true,
              "type": "integer",
              "minimum": 1,
              "maximum": 10000
            },
            "leadMagnet": {
              "default": null,
              "nullable": true,
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "maxLength": 120
                },
                "whatItIs": {
                  "type": "string",
                  "maxLength": 400
                }
              },
              "required": [
                "name",
                "whatItIs"
              ],
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        },
        "audience": {
          "default": {},
          "type": "object",
          "properties": {
            "nicheSlug": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "description": {
              "default": "",
              "type": "string",
              "maxLength": 400
            },
            "revenueBand": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "region": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "notFor": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            }
          },
          "additionalProperties": false
        },
        "pain": {
          "default": {},
          "type": "object",
          "properties": {
            "complaintsVerbatim": {
              "default": [],
              "maxItems": 6,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            },
            "bottleneck": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            }
          },
          "additionalProperties": false
        },
        "proof": {
          "default": {},
          "type": "object",
          "properties": {
            "results": {
              "default": [],
              "maxItems": 8,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "client": {
                    "type": "string",
                    "maxLength": 120
                  },
                  "result": {
                    "type": "string",
                    "maxLength": 200
                  },
                  "timeframe": {
                    "default": null,
                    "nullable": true,
                    "type": "string",
                    "maxLength": 60
                  }
                },
                "required": [
                  "client",
                  "result"
                ],
                "additionalProperties": false
              }
            },
            "testimonials": {
              "default": [],
              "maxItems": 50,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "quote": {
                    "type": "string",
                    "maxLength": 800
                  },
                  "imageUrl": {
                    "nullable": true,
                    "type": "string",
                    "maxLength": 2000,
                    "format": "uri"
                  },
                  "media": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "none"
                            ]
                          }
                        },
                        "required": [
                          "kind"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "wistia"
                            ]
                          },
                          "mediaId": {
                            "type": "string",
                            "maxLength": 12,
                            "description": "Wistia hashed id, 8 to 12 lowercase letters and digits."
                          },
                          "landerMediaId": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 40
                          },
                          "poster": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 400,
                            "description": "Absolute http or https URL, or null."
                          },
                          "aspect": {
                            "default": 1.7777777777777777,
                            "type": "number",
                            "minimum": 0.2,
                            "maximum": 5
                          },
                          "autoplay": {
                            "default": false,
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "kind",
                          "mediaId"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "youtube",
                              "vimeo",
                              "loom"
                            ]
                          },
                          "url": {
                            "type": "string",
                            "maxLength": 400,
                            "description": "A YouTube, Vimeo, or Loom share URL."
                          },
                          "poster": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 400,
                            "description": "Absolute http or https URL, or null."
                          },
                          "aspect": {
                            "default": 1.7777777777777777,
                            "type": "number",
                            "minimum": 0.2,
                            "maximum": 5
                          },
                          "autoplay": {
                            "default": false,
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "kind",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "audio"
                            ]
                          },
                          "url": {
                            "type": "string",
                            "maxLength": 400,
                            "description": "Absolute http or https URL, or null."
                          },
                          "caption": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 120
                          }
                        },
                        "required": [
                          "kind",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "image"
                            ]
                          },
                          "url": {
                            "type": "string",
                            "maxLength": 400,
                            "description": "Absolute http or https URL, or null."
                          },
                          "caption": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 120
                          }
                        },
                        "required": [
                          "kind",
                          "url"
                        ],
                        "additionalProperties": false
                      }
                    ]
                  },
                  "name": {
                    "type": "string",
                    "maxLength": 80
                  },
                  "role": {
                    "default": null,
                    "nullable": true,
                    "type": "string",
                    "maxLength": 80
                  }
                },
                "required": [
                  "quote",
                  "name"
                ],
                "additionalProperties": false
              }
            },
            "logos": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 80
              }
            },
            "rating": {
              "default": null,
              "nullable": true,
              "type": "object",
              "properties": {
                "value": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 5
                },
                "count": {
                  "type": "integer",
                  "minimum": 0
                },
                "platform": {
                  "type": "string",
                  "maxLength": 40
                },
                "url": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 400
                }
              },
              "required": [
                "value",
                "count",
                "platform"
              ],
              "additionalProperties": false
            },
            "yearsOrClients": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "recordingUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400
            }
          },
          "additionalProperties": false
        },
        "call": {
          "default": {},
          "type": "object",
          "properties": {
            "name": {
              "default": "",
              "type": "string",
              "maxLength": 80
            },
            "minutes": {
              "default": 30,
              "type": "integer",
              "minimum": 5,
              "maximum": 120
            },
            "host": {
              "default": "",
              "type": "string",
              "maxLength": 80
            },
            "hostRole": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "hostBio": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 600
            },
            "agenda": {
              "default": [],
              "maxItems": 5,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 160
              }
            },
            "leaveWith": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 200
            },
            "guarantee": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            }
          },
          "additionalProperties": false
        },
        "compliance": {
          "default": {},
          "type": "object",
          "properties": {
            "neverSay": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 120
              }
            },
            "flags": {
              "default": [],
              "maxItems": 3,
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "hipaa",
                  "tcpa",
                  "financial"
                ]
              }
            }
          },
          "additionalProperties": false
        },
        "video": {
          "default": {},
          "type": "object",
          "properties": {
            "has": {
              "default": false,
              "type": "boolean"
            },
            "url": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400
            }
          },
          "additionalProperties": false
        },
        "traffic": {
          "default": "cold_ads",
          "type": "string",
          "enum": [
            "cold_ads",
            "warm_outbound",
            "organic",
            "mixed"
          ]
        },
        "vibe": {
          "default": "clean",
          "type": "string",
          "enum": [
            "clean",
            "bold",
            "dark",
            "friendly"
          ]
        },
        "preset": {
          "default": "quiz_first",
          "type": "string",
          "enum": [
            "vsl_demo",
            "quiz_first",
            "sales_letter",
            "case_study"
          ]
        },
        "questionCount": {
          "default": null,
          "nullable": true,
          "type": "integer",
          "minimum": 0,
          "maximum": 12
        }
      },
      "additionalProperties": false
    },
    "bookingUrl": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4000
    },
    "legal": {
      "default": {},
      "type": "object",
      "properties": {
        "companyLine": {
          "default": "",
          "type": "string",
          "maxLength": 200
        },
        "platformDisclaimer": {
          "default": true,
          "type": "boolean"
        },
        "earningsDisclaimer": {
          "default": true,
          "type": "boolean"
        },
        "privacyUrl": {
          "default": null,
          "nullable": true,
          "type": "string",
          "maxLength": 400,
          "description": "Absolute http or https URL, or null."
        },
        "termsUrl": {
          "default": null,
          "nullable": true,
          "type": "string",
          "maxLength": 400,
          "description": "Absolute http or https URL, or null."
        },
        "privacyText": {
          "default": null,
          "nullable": true,
          "type": "string",
          "maxLength": 20000
        },
        "termsText": {
          "default": null,
          "nullable": true,
          "type": "string",
          "maxLength": 20000
        },
        "footerNote": {
          "default": null,
          "nullable": true,
          "type": "string",
          "maxLength": 300
        },
        "sources": {
          "default": true,
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "logoUrl": {
      "nullable": true,
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "name",
    "facts",
    "bookingUrl"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/landers/{lander_id}Replace a landing page document

Replaces the name, the vertical, and the whole page document, and the scripts when they are sent. Read the lander first and send the document back changed; missing fields fall back to the schema defaults rather than to what is stored. Publishing is a separate operation.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "nicheId": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    },
    "document": {
      "type": "object",
      "properties": {
        "version": {
          "default": 1,
          "type": "number",
          "enum": [
            1
          ]
        },
        "funnel": {
          "default": {},
          "type": "object",
          "properties": {
            "entry": {
              "default": "apply",
              "type": "string",
              "enum": [
                "apply",
                "inlineBooking",
                "optin"
              ]
            },
            "preset": {
              "default": "quiz_first",
              "type": "string",
              "enum": [
                "vsl_demo",
                "quiz_first",
                "sales_letter",
                "case_study"
              ]
            }
          },
          "additionalProperties": false
        },
        "theme": {
          "default": {},
          "type": "object",
          "properties": {
            "mode": {
              "default": "light",
              "type": "string",
              "enum": [
                "light",
                "dark"
              ]
            },
            "fontFamily": {
              "default": "inter",
              "type": "string",
              "enum": [
                "inter",
                "roboto",
                "poppins",
                "manrope",
                "dm-sans",
                "plus-jakarta"
              ]
            },
            "background": {
              "default": "#ffffff",
              "type": "string",
              "maxLength": 7,
              "description": "Colour as #rrggbb."
            },
            "foreground": {
              "default": "#0f172a",
              "type": "string",
              "maxLength": 7,
              "description": "Colour as #rrggbb."
            },
            "primary": {
              "default": "#2563eb",
              "type": "string",
              "maxLength": 7,
              "description": "Colour as #rrggbb."
            },
            "accent": {
              "default": "#2563eb",
              "type": "string",
              "maxLength": 7,
              "description": "Colour as #rrggbb."
            },
            "card": {
              "default": "#f8fafc",
              "type": "string",
              "maxLength": 7,
              "description": "Colour as #rrggbb."
            },
            "muted": {
              "default": "#64748b",
              "type": "string",
              "maxLength": 7,
              "description": "Colour as #rrggbb."
            },
            "starColor": {
              "default": "#f59e0b",
              "type": "string",
              "maxLength": 7,
              "description": "Colour as #rrggbb."
            },
            "radius": {
              "default": "medium",
              "type": "string",
              "enum": [
                "small",
                "medium",
                "large"
              ]
            },
            "heroStyle": {
              "default": "clean",
              "type": "string",
              "enum": [
                "clean",
                "gradient",
                "image",
                "dark"
              ]
            },
            "heroImageUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400,
              "description": "Absolute http or https URL, or null."
            }
          },
          "additionalProperties": false
        },
        "header": {
          "default": {},
          "type": "object",
          "properties": {
            "showLogo": {
              "default": true,
              "type": "boolean"
            },
            "logoUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400,
              "description": "Absolute http or https URL, or null."
            },
            "name": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "ctaLabel": {
              "default": null,
              "description": "Leave null; one label repeats.",
              "nullable": true,
              "type": "string",
              "maxLength": 40
            }
          },
          "additionalProperties": false
        },
        "cta": {
          "default": {},
          "type": "object",
          "properties": {
            "label": {
              "default": "Book a call",
              "type": "string",
              "maxLength": 60
            },
            "sub": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "mode": {
              "default": "persistent",
              "type": "string",
              "enum": [
                "persistent",
                "delayed"
              ]
            },
            "revealAtSeconds": {
              "default": 0,
              "type": "number",
              "minimum": 0,
              "maximum": 3600
            },
            "softLabel": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 60
            },
            "trustLine": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 160
            }
          },
          "additionalProperties": false
        },
        "video": {
          "default": {
            "kind": "none"
          },
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "none"
                  ]
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "wistia"
                  ]
                },
                "mediaId": {
                  "type": "string",
                  "maxLength": 12,
                  "description": "Wistia hashed id, 8 to 12 lowercase letters and digits."
                },
                "landerMediaId": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 40
                },
                "poster": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 400,
                  "description": "Absolute http or https URL, or null."
                },
                "aspect": {
                  "default": 1.7777777777777777,
                  "type": "number",
                  "minimum": 0.2,
                  "maximum": 5
                },
                "autoplay": {
                  "default": false,
                  "type": "boolean"
                }
              },
              "required": [
                "kind",
                "mediaId"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "youtube",
                    "vimeo",
                    "loom"
                  ]
                },
                "url": {
                  "type": "string",
                  "maxLength": 400,
                  "description": "A YouTube, Vimeo, or Loom share URL."
                },
                "poster": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 400,
                  "description": "Absolute http or https URL, or null."
                },
                "aspect": {
                  "default": 1.7777777777777777,
                  "type": "number",
                  "minimum": 0.2,
                  "maximum": 5
                },
                "autoplay": {
                  "default": false,
                  "type": "boolean"
                }
              },
              "required": [
                "kind",
                "url"
              ],
              "additionalProperties": false
            }
          ]
        },
        "proof": {
          "default": {},
          "type": "object",
          "properties": {
            "rating": {
              "default": null,
              "nullable": true,
              "type": "object",
              "properties": {
                "value": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 5
                },
                "count": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 1000000
                },
                "platform": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 40
                },
                "url": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 400,
                  "description": "Absolute http or https URL, or null."
                }
              },
              "required": [
                "value",
                "count"
              ],
              "additionalProperties": false
            },
            "logos": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 80
                  },
                  "imageUrl": {
                    "default": null,
                    "nullable": true,
                    "type": "string",
                    "maxLength": 400,
                    "description": "Absolute http or https URL, or null."
                  }
                },
                "required": [
                  "name"
                ],
                "additionalProperties": false
              }
            }
          },
          "additionalProperties": false
        },
        "hero": {
          "default": {},
          "type": "object",
          "properties": {
            "eyebrow": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "eyebrowHighlight": {
              "default": false,
              "type": "boolean"
            },
            "headline": {
              "default": "",
              "type": "string",
              "maxLength": 200
            },
            "headlineFormula": {
              "default": "C",
              "type": "string",
              "enum": [
                "A",
                "B",
                "C",
                "D"
              ]
            },
            "subheadline": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            },
            "disarmLine": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 200
            },
            "valueAnchor": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 160
            },
            "showVideo": {
              "default": true,
              "type": "boolean"
            },
            "captionLine": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 160
            },
            "mockupImageUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400,
              "description": "Absolute http or https URL, or null."
            },
            "inlineQuestionKey": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 8
            },
            "showRating": {
              "default": false,
              "type": "boolean"
            },
            "showLogos": {
              "default": false,
              "type": "boolean"
            },
            "scrollCue": {
              "default": false,
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "sections": {
          "default": [],
          "maxItems": 24,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 40
              },
              "type": {
                "type": "string",
                "enum": [
                  "logos",
                  "pain",
                  "bridge",
                  "mechanism",
                  "proofItems",
                  "benefits",
                  "callPitch",
                  "bookingInline",
                  "letter",
                  "fascinations",
                  "notFor",
                  "steps",
                  "founder",
                  "authority",
                  "faq",
                  "urgency",
                  "closing",
                  "confirm",
                  "nextSteps",
                  "prepVideo",
                  "agenda",
                  "prepare",
                  "team",
                  "caseStudies",
                  "bonus",
                  "signoff"
                ]
              },
              "enabled": {
                "default": true,
                "type": "boolean"
              },
              "data": {
                "default": {},
                "type": "object",
                "additionalProperties": {}
              }
            },
            "required": [
              "id",
              "type"
            ],
            "additionalProperties": false
          }
        },
        "watch": {
          "default": {},
          "type": "object",
          "properties": {
            "headline": {
              "default": "",
              "type": "string",
              "maxLength": 200
            },
            "sub": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            },
            "video": {
              "default": {
                "kind": "none"
              },
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "none"
                      ]
                    }
                  },
                  "required": [
                    "kind"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "wistia"
                      ]
                    },
                    "mediaId": {
                      "type": "string",
                      "maxLength": 12,
                      "description": "Wistia hashed id, 8 to 12 lowercase letters and digits."
                    },
                    "landerMediaId": {
                      "default": null,
                      "nullable": true,
                      "type": "string",
                      "maxLength": 40
                    },
                    "poster": {
                      "default": null,
                      "nullable": true,
                      "type": "string",
                      "maxLength": 400,
                      "description": "Absolute http or https URL, or null."
                    },
                    "aspect": {
                      "default": 1.7777777777777777,
                      "type": "number",
                      "minimum": 0.2,
                      "maximum": 5
                    },
                    "autoplay": {
                      "default": false,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "kind",
                    "mediaId"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "youtube",
                        "vimeo",
                        "loom"
                      ]
                    },
                    "url": {
                      "type": "string",
                      "maxLength": 400,
                      "description": "A YouTube, Vimeo, or Loom share URL."
                    },
                    "poster": {
                      "default": null,
                      "nullable": true,
                      "type": "string",
                      "maxLength": 400,
                      "description": "Absolute http or https URL, or null."
                    },
                    "aspect": {
                      "default": 1.7777777777777777,
                      "type": "number",
                      "minimum": 0.2,
                      "maximum": 5
                    },
                    "autoplay": {
                      "default": false,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "kind",
                    "url"
                  ],
                  "additionalProperties": false
                }
              ]
            },
            "ctaSub": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "valueAnchor": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 160
            },
            "showRating": {
              "default": false,
              "type": "boolean"
            },
            "showLogos": {
              "default": false,
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "form": {
          "default": {},
          "type": "object",
          "properties": {
            "intro": {
              "default": {},
              "type": "object",
              "properties": {
                "eyebrow": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 80
                },
                "headline": {
                  "default": "A few quick questions",
                  "type": "string",
                  "maxLength": 200
                },
                "sub": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 300
                },
                "showRating": {
                  "default": false,
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            },
            "contactPosition": {
              "default": "last",
              "type": "string",
              "enum": [
                "first",
                "last"
              ]
            },
            "steps": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "choice"
                        ]
                      },
                      "key": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 8,
                        "description": "q1..qN, assigned on add and never renamed."
                      },
                      "label": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 60
                      },
                      "stepLabel": {
                        "default": null,
                        "nullable": true,
                        "type": "string",
                        "maxLength": 60
                      },
                      "prompt": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200
                      },
                      "reasonWhy": {
                        "default": null,
                        "nullable": true,
                        "type": "string",
                        "maxLength": 200
                      },
                      "multiple": {
                        "default": false,
                        "type": "boolean"
                      },
                      "visual": {
                        "default": "list",
                        "type": "string",
                        "enum": [
                          "tiles",
                          "list"
                        ]
                      },
                      "options": {
                        "default": [],
                        "maxItems": 8,
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "key": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 16
                            },
                            "label": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 120
                            },
                            "emoji": {
                              "default": null,
                              "nullable": true,
                              "type": "string",
                              "maxLength": 8
                            },
                            "imageUrl": {
                              "default": null,
                              "nullable": true,
                              "type": "string",
                              "maxLength": 400,
                              "description": "Absolute http or https URL, or null."
                            },
                            "weight": {
                              "anyOf": [
                                {
                                  "type": "string",
                                  "enum": [
                                    "dq"
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    0
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    1
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    2
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    3
                                  ]
                                }
                              ],
                              "description": "dq disqualifies; 0 to 3 scores."
                            }
                          },
                          "required": [
                            "key",
                            "label",
                            "weight"
                          ],
                          "additionalProperties": false
                        }
                      }
                    },
                    "required": [
                      "kind",
                      "key",
                      "label",
                      "prompt"
                    ],
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "input"
                        ]
                      },
                      "key": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 8,
                        "description": "q1..qN, assigned on add and never renamed."
                      },
                      "label": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 60
                      },
                      "stepLabel": {
                        "default": null,
                        "nullable": true,
                        "type": "string",
                        "maxLength": 60
                      },
                      "prompt": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200
                      },
                      "reasonWhy": {
                        "default": null,
                        "nullable": true,
                        "type": "string",
                        "maxLength": 200
                      },
                      "inputType": {
                        "default": "text",
                        "type": "string",
                        "enum": [
                          "text",
                          "textarea",
                          "url",
                          "number",
                          "select"
                        ]
                      },
                      "options": {
                        "default": [],
                        "maxItems": 12,
                        "type": "array",
                        "items": {
                          "type": "string",
                          "maxLength": 120
                        }
                      },
                      "placeholder": {
                        "default": null,
                        "nullable": true,
                        "type": "string",
                        "maxLength": 80
                      },
                      "required": {
                        "default": true,
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "kind",
                      "key",
                      "label",
                      "prompt"
                    ],
                    "additionalProperties": false
                  }
                ]
              }
            },
            "contact": {
              "default": {},
              "type": "object",
              "properties": {
                "fields": {
                  "default": [
                    "name",
                    "phone"
                  ],
                  "maxItems": 3,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "name",
                      "phone",
                      "company"
                    ]
                  }
                },
                "required": {
                  "default": [
                    "name"
                  ],
                  "maxItems": 3,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "name",
                      "phone",
                      "company"
                    ]
                  }
                },
                "consentText": {
                  "default": "By continuing you agree to be contacted about your application.",
                  "type": "string",
                  "maxLength": 400
                },
                "submitLabel": {
                  "default": "Continue",
                  "type": "string",
                  "maxLength": 60
                }
              },
              "additionalProperties": false
            },
            "commitment": {
              "default": {},
              "type": "object",
              "properties": {
                "enabled": {
                  "default": true,
                  "type": "boolean"
                },
                "prompt": {
                  "default": "If the call shows this is a fit, are you ready to move forward?",
                  "type": "string",
                  "maxLength": 200
                },
                "yesLabel": {
                  "default": "Yes, if it fits",
                  "type": "string",
                  "maxLength": 60
                },
                "noLabel": {
                  "default": "Not yet",
                  "type": "string",
                  "maxLength": 60
                }
              },
              "additionalProperties": false
            },
            "verifying": {
              "default": {},
              "type": "object",
              "properties": {
                "enabled": {
                  "default": true,
                  "type": "boolean"
                },
                "lines": {
                  "default": [
                    "Checking your answers",
                    "Finding a time that works"
                  ],
                  "minItems": 2,
                  "maxItems": 2,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "maxLength": 120
                  },
                  "description": "Exactly two lines."
                },
                "seconds": {
                  "default": 4,
                  "type": "number",
                  "minimum": 1,
                  "maximum": 10
                }
              },
              "additionalProperties": false
            },
            "scoring": {
              "default": {},
              "type": "object",
              "properties": {
                "threshold": {
                  "default": 0,
                  "type": "integer",
                  "minimum": 0
                },
                "maxScore": {
                  "default": 0,
                  "type": "integer",
                  "minimum": 0
                }
              },
              "description": "Computed from option weights by the lib, never by the model.",
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        },
        "booking": {
          "default": {},
          "type": "object",
          "properties": {
            "url": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400,
              "description": "Absolute http or https URL, or null."
            },
            "provider": {
              "default": "auto",
              "type": "string",
              "enum": [
                "auto",
                "calendly",
                "cal_com",
                "gohighlevel",
                "hubspot",
                "tidycal",
                "acuity",
                "zoho",
                "youcanbookme",
                "savvycal",
                "google",
                "microsoft",
                "link"
              ]
            },
            "mode": {
              "default": "inline",
              "type": "string",
              "enum": [
                "inline",
                "newTab"
              ]
            },
            "headline": {
              "default": "Pick a time",
              "type": "string",
              "maxLength": 200
            },
            "sub": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            },
            "bullets": {
              "default": [],
              "maxItems": 5,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 160
              }
            },
            "hostName": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "minutes": {
              "default": null,
              "nullable": true,
              "type": "integer",
              "minimum": 5,
              "maximum": 120
            },
            "noFitLine": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 200
            },
            "scarcity": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 160
            },
            "prefill": {
              "default": true,
              "type": "boolean"
            },
            "passAnswers": {
              "default": false,
              "type": "boolean"
            },
            "continueLabel": {
              "default": "I've booked, continue",
              "type": "string",
              "maxLength": 60
            },
            "showRating": {
              "default": false,
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "thankYou": {
          "default": {},
          "type": "object",
          "properties": {
            "sections": {
              "default": [],
              "maxItems": 24,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 40
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "logos",
                      "pain",
                      "bridge",
                      "mechanism",
                      "proofItems",
                      "benefits",
                      "callPitch",
                      "bookingInline",
                      "letter",
                      "fascinations",
                      "notFor",
                      "steps",
                      "founder",
                      "authority",
                      "faq",
                      "urgency",
                      "closing",
                      "confirm",
                      "nextSteps",
                      "prepVideo",
                      "agenda",
                      "prepare",
                      "team",
                      "caseStudies",
                      "bonus",
                      "signoff"
                    ]
                  },
                  "enabled": {
                    "default": true,
                    "type": "boolean"
                  },
                  "data": {
                    "default": {},
                    "type": "object",
                    "additionalProperties": {}
                  }
                },
                "required": [
                  "id",
                  "type"
                ],
                "additionalProperties": false
              }
            },
            "showAddToCalendar": {
              "default": true,
              "type": "boolean"
            },
            "showConfirmAttendance": {
              "default": true,
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "notFit": {
          "default": {},
          "type": "object",
          "properties": {
            "headline": {
              "default": "Thanks for applying",
              "type": "string",
              "maxLength": 200
            },
            "body": {
              "default": "From your answers this is not the right fit today. We would rather tell you now than waste your time on a call.",
              "type": "string",
              "maxLength": 800
            },
            "reapplyWhen": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 200
            },
            "resourceLabel": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 60
            },
            "resourceUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400,
              "description": "Absolute http or https URL, or null."
            },
            "showRating": {
              "default": false,
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "legal": {
          "default": {},
          "type": "object",
          "properties": {
            "companyLine": {
              "default": "",
              "type": "string",
              "maxLength": 200
            },
            "platformDisclaimer": {
              "default": true,
              "type": "boolean"
            },
            "earningsDisclaimer": {
              "default": true,
              "type": "boolean"
            },
            "privacyUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400,
              "description": "Absolute http or https URL, or null."
            },
            "termsUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400,
              "description": "Absolute http or https URL, or null."
            },
            "privacyText": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 20000
            },
            "termsText": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 20000
            },
            "footerNote": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            },
            "sources": {
              "default": true,
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "seo": {
          "default": {},
          "type": "object",
          "properties": {
            "title": {
              "default": "",
              "type": "string",
              "maxLength": 70
            },
            "description": {
              "default": "",
              "type": "string",
              "maxLength": 200
            },
            "ogImageUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400,
              "description": "Absolute http or https URL, or null."
            },
            "indexable": {
              "default": false,
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "tracking": {
          "default": {},
          "type": "object",
          "properties": {
            "metaPixelId": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 16,
              "description": "15 or 16 digits."
            },
            "ga4MeasurementId": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 15,
              "description": "G- followed by 4 to 12 uppercase letters or digits."
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "scripts": {
      "type": "object",
      "properties": {
        "vsl": {
          "default": null,
          "nullable": true,
          "type": "object",
          "properties": {
            "beats": {
              "default": [],
              "maxItems": 20,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "enum": [
                      "hook",
                      "callout",
                      "problem",
                      "mistakes",
                      "mechanism",
                      "proof",
                      "offer",
                      "guarantee",
                      "faq",
                      "cta"
                    ]
                  },
                  "text": {
                    "type": "string",
                    "maxLength": 6000
                  }
                },
                "required": [
                  "name",
                  "text"
                ],
                "additionalProperties": false
              }
            },
            "wordCount": {
              "default": 0,
              "type": "integer",
              "minimum": 0
            },
            "targetMinutes": {
              "default": 3,
              "type": "number",
              "minimum": 0,
              "maximum": 60
            }
          },
          "additionalProperties": false
        },
        "prep": {
          "default": null,
          "nullable": true,
          "type": "object",
          "properties": {
            "text": {
              "type": "string",
              "maxLength": 6000
            },
            "wordCount": {
              "default": 0,
              "type": "integer",
              "minimum": 0
            }
          },
          "required": [
            "text"
          ],
          "additionalProperties": false
        },
        "demo": {
          "default": null,
          "nullable": true,
          "type": "object",
          "properties": {
            "text": {
              "type": "string",
              "maxLength": 3000
            },
            "wordCount": {
              "default": 0,
              "type": "integer",
              "minimum": 0
            }
          },
          "required": [
            "text"
          ],
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "name",
    "nicheId",
    "document"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/landers/{lander_id}/generationsHave the AI write one phase of a landing page

One phase per request, each spending one Lumina AI credit: page, then funnel, then thankYou for a whole page, or script, section, or part on their own. The response names the phase to run next, or null when the run is complete. A 402 means the meter is spent.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "page",
        "funnel",
        "thankYou",
        "script",
        "section",
        "part"
      ]
    },
    "sectionId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "part": {
      "type": "string",
      "enum": [
        "hero",
        "cta",
        "header",
        "theme",
        "video",
        "proof",
        "watch",
        "booking",
        "notFit",
        "legal",
        "seo",
        "tracking",
        "formSettings",
        "funnel"
      ]
    }
  },
  "required": [
    "scope"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "scope": {
      "type": "string",
      "enum": [
        "page",
        "section",
        "part",
        "script",
        "funnel",
        "thankYou"
      ]
    },
    "document": {
      "type": "object",
      "properties": {
        "version": {
          "type": "number",
          "enum": [
            1
          ]
        },
        "funnel": {
          "type": "object",
          "properties": {
            "entry": {
              "type": "string",
              "enum": [
                "optin",
                "apply",
                "inlineBooking"
              ]
            },
            "preset": {
              "type": "string",
              "enum": [
                "case_study",
                "vsl_demo",
                "quiz_first",
                "sales_letter"
              ]
            }
          },
          "required": [
            "entry",
            "preset"
          ],
          "additionalProperties": false
        },
        "theme": {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string",
              "enum": [
                "light",
                "dark"
              ]
            },
            "fontFamily": {
              "type": "string",
              "enum": [
                "inter",
                "roboto",
                "poppins",
                "manrope",
                "dm-sans",
                "plus-jakarta"
              ]
            },
            "background": {
              "type": "string"
            },
            "foreground": {
              "type": "string"
            },
            "primary": {
              "type": "string"
            },
            "accent": {
              "type": "string"
            },
            "card": {
              "type": "string"
            },
            "muted": {
              "type": "string"
            },
            "starColor": {
              "type": "string"
            },
            "radius": {
              "type": "string",
              "enum": [
                "small",
                "medium",
                "large"
              ]
            },
            "heroStyle": {
              "type": "string",
              "enum": [
                "image",
                "dark",
                "clean",
                "gradient"
              ]
            },
            "heroImageUrl": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "mode",
            "fontFamily",
            "background",
            "foreground",
            "primary",
            "accent",
            "card",
            "muted",
            "starColor",
            "radius",
            "heroStyle",
            "heroImageUrl"
          ],
          "additionalProperties": false
        },
        "header": {
          "type": "object",
          "properties": {
            "showLogo": {
              "type": "boolean"
            },
            "logoUrl": {
              "type": "string",
              "nullable": true
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "ctaLabel": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "showLogo",
            "logoUrl",
            "name",
            "ctaLabel"
          ],
          "additionalProperties": false
        },
        "cta": {
          "type": "object",
          "properties": {
            "label": {
              "type": "string"
            },
            "sub": {
              "type": "string",
              "nullable": true
            },
            "mode": {
              "type": "string",
              "enum": [
                "persistent",
                "delayed"
              ]
            },
            "revealAtSeconds": {
              "type": "number"
            },
            "softLabel": {
              "type": "string",
              "nullable": true
            },
            "trustLine": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "label",
            "sub",
            "mode",
            "revealAtSeconds",
            "softLabel",
            "trustLine"
          ],
          "additionalProperties": false
        },
        "video": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "none"
                  ]
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "wistia"
                  ]
                },
                "mediaId": {
                  "type": "string"
                },
                "landerMediaId": {
                  "type": "string",
                  "nullable": true
                },
                "poster": {
                  "type": "string",
                  "nullable": true
                },
                "aspect": {
                  "type": "number"
                },
                "autoplay": {
                  "type": "boolean"
                }
              },
              "required": [
                "kind",
                "mediaId",
                "landerMediaId",
                "poster",
                "aspect",
                "autoplay"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "youtube",
                    "vimeo",
                    "loom"
                  ]
                },
                "url": {
                  "type": "string"
                },
                "poster": {
                  "type": "string",
                  "nullable": true
                },
                "aspect": {
                  "type": "number"
                },
                "autoplay": {
                  "type": "boolean"
                }
              },
              "required": [
                "kind",
                "url",
                "poster",
                "aspect",
                "autoplay"
              ],
              "additionalProperties": false
            }
          ]
        },
        "proof": {
          "type": "object",
          "properties": {
            "rating": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "number"
                },
                "count": {
                  "type": "number"
                },
                "platform": {
                  "type": "string",
                  "nullable": true
                },
                "url": {
                  "type": "string",
                  "nullable": true
                }
              },
              "required": [
                "value",
                "count",
                "platform",
                "url"
              ],
              "additionalProperties": false,
              "nullable": true
            },
            "logos": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "imageUrl": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "required": [
                  "name",
                  "imageUrl"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "rating",
            "logos"
          ],
          "additionalProperties": false
        },
        "hero": {
          "type": "object",
          "properties": {
            "eyebrow": {
              "type": "string",
              "nullable": true
            },
            "eyebrowHighlight": {
              "type": "boolean"
            },
            "headline": {
              "type": "string"
            },
            "headlineFormula": {
              "type": "string",
              "enum": [
                "A",
                "B",
                "C",
                "D"
              ]
            },
            "subheadline": {
              "type": "string",
              "nullable": true
            },
            "disarmLine": {
              "type": "string",
              "nullable": true
            },
            "valueAnchor": {
              "type": "string",
              "nullable": true
            },
            "showVideo": {
              "type": "boolean"
            },
            "captionLine": {
              "type": "string",
              "nullable": true
            },
            "mockupImageUrl": {
              "type": "string",
              "nullable": true
            },
            "inlineQuestionKey": {
              "type": "string",
              "nullable": true
            },
            "showRating": {
              "type": "boolean"
            },
            "showLogos": {
              "type": "boolean"
            },
            "scrollCue": {
              "type": "boolean"
            }
          },
          "required": [
            "eyebrow",
            "eyebrowHighlight",
            "headline",
            "headlineFormula",
            "subheadline",
            "disarmLine",
            "valueAnchor",
            "showVideo",
            "captionLine",
            "mockupImageUrl",
            "inlineQuestionKey",
            "showRating",
            "showLogos",
            "scrollCue"
          ],
          "additionalProperties": false
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "faq",
                  "urgency",
                  "confirm",
                  "notFor",
                  "pain",
                  "logos",
                  "agenda",
                  "bridge",
                  "mechanism",
                  "proofItems",
                  "benefits",
                  "callPitch",
                  "bookingInline",
                  "letter",
                  "fascinations",
                  "steps",
                  "founder",
                  "authority",
                  "closing",
                  "nextSteps",
                  "prepVideo",
                  "prepare",
                  "team",
                  "caseStudies",
                  "bonus",
                  "signoff"
                ]
              },
              "enabled": {
                "type": "boolean"
              },
              "data": {
                "type": "object",
                "additionalProperties": {}
              }
            },
            "required": [
              "id",
              "type",
              "enabled",
              "data"
            ],
            "additionalProperties": false
          }
        },
        "watch": {
          "type": "object",
          "properties": {
            "headline": {
              "type": "string"
            },
            "sub": {
              "type": "string",
              "nullable": true
            },
            "video": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "none"
                      ]
                    }
                  },
                  "required": [
                    "kind"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "wistia"
                      ]
                    },
                    "mediaId": {
                      "type": "string"
                    },
                    "landerMediaId": {
                      "type": "string",
                      "nullable": true
                    },
                    "poster": {
                      "type": "string",
                      "nullable": true
                    },
                    "aspect": {
                      "type": "number"
                    },
                    "autoplay": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "kind",
                    "mediaId",
                    "landerMediaId",
                    "poster",
                    "aspect",
                    "autoplay"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "youtube",
                        "vimeo",
                        "loom"
                      ]
                    },
                    "url": {
                      "type": "string"
                    },
                    "poster": {
                      "type": "string",
                      "nullable": true
                    },
                    "aspect": {
                      "type": "number"
                    },
                    "autoplay": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "kind",
                    "url",
                    "poster",
                    "aspect",
                    "autoplay"
                  ],
                  "additionalProperties": false
                }
              ]
            },
            "ctaSub": {
              "type": "string",
              "nullable": true
            },
            "valueAnchor": {
              "type": "string",
              "nullable": true
            },
            "showRating": {
              "type": "boolean"
            },
            "showLogos": {
              "type": "boolean"
            }
          },
          "required": [
            "headline",
            "sub",
            "video",
            "ctaSub",
            "valueAnchor",
            "showRating",
            "showLogos"
          ],
          "additionalProperties": false
        },
        "form": {
          "type": "object",
          "properties": {
            "intro": {
              "type": "object",
              "properties": {
                "eyebrow": {
                  "type": "string",
                  "nullable": true
                },
                "headline": {
                  "type": "string"
                },
                "sub": {
                  "type": "string",
                  "nullable": true
                },
                "showRating": {
                  "type": "boolean"
                }
              },
              "required": [
                "eyebrow",
                "headline",
                "sub",
                "showRating"
              ],
              "additionalProperties": false
            },
            "contactPosition": {
              "type": "string",
              "enum": [
                "last",
                "first"
              ]
            },
            "steps": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "multiple": {
                        "type": "boolean"
                      },
                      "visual": {
                        "type": "string",
                        "enum": [
                          "list",
                          "tiles"
                        ]
                      },
                      "options": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "key": {
                              "type": "string"
                            },
                            "label": {
                              "type": "string"
                            },
                            "emoji": {
                              "type": "string",
                              "nullable": true
                            },
                            "imageUrl": {
                              "type": "string",
                              "nullable": true
                            },
                            "weight": {
                              "anyOf": [
                                {
                                  "type": "number",
                                  "enum": [
                                    0
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    1
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    2
                                  ]
                                },
                                {
                                  "type": "string",
                                  "enum": [
                                    "dq"
                                  ]
                                },
                                {
                                  "type": "number",
                                  "enum": [
                                    3
                                  ]
                                }
                              ]
                            }
                          },
                          "required": [
                            "key",
                            "label",
                            "emoji",
                            "imageUrl",
                            "weight"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "key": {
                        "type": "string"
                      },
                      "label": {
                        "type": "string"
                      },
                      "stepLabel": {
                        "type": "string",
                        "nullable": true
                      },
                      "prompt": {
                        "type": "string"
                      },
                      "reasonWhy": {
                        "type": "string",
                        "nullable": true
                      },
                      "kind": {
                        "type": "string",
                        "enum": [
                          "choice"
                        ]
                      }
                    },
                    "required": [
                      "multiple",
                      "visual",
                      "options",
                      "key",
                      "label",
                      "stepLabel",
                      "prompt",
                      "reasonWhy",
                      "kind"
                    ],
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "properties": {
                      "inputType": {
                        "type": "string",
                        "enum": [
                          "number",
                          "text",
                          "textarea",
                          "url",
                          "select"
                        ]
                      },
                      "options": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "placeholder": {
                        "type": "string",
                        "nullable": true
                      },
                      "required": {
                        "type": "boolean"
                      },
                      "key": {
                        "type": "string"
                      },
                      "label": {
                        "type": "string"
                      },
                      "stepLabel": {
                        "type": "string",
                        "nullable": true
                      },
                      "prompt": {
                        "type": "string"
                      },
                      "reasonWhy": {
                        "type": "string",
                        "nullable": true
                      },
                      "kind": {
                        "type": "string",
                        "enum": [
                          "input"
                        ]
                      }
                    },
                    "required": [
                      "inputType",
                      "options",
                      "placeholder",
                      "required",
                      "key",
                      "label",
                      "stepLabel",
                      "prompt",
                      "reasonWhy",
                      "kind"
                    ],
                    "additionalProperties": false
                  }
                ]
              }
            },
            "contact": {
              "type": "object",
              "properties": {
                "fields": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "name",
                      "phone",
                      "company"
                    ]
                  }
                },
                "required": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "name",
                      "phone",
                      "company"
                    ]
                  }
                },
                "consentText": {
                  "type": "string"
                },
                "submitLabel": {
                  "type": "string"
                }
              },
              "required": [
                "fields",
                "required",
                "consentText",
                "submitLabel"
              ],
              "additionalProperties": false
            },
            "commitment": {
              "type": "object",
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "prompt": {
                  "type": "string"
                },
                "yesLabel": {
                  "type": "string"
                },
                "noLabel": {
                  "type": "string"
                }
              },
              "required": [
                "enabled",
                "prompt",
                "yesLabel",
                "noLabel"
              ],
              "additionalProperties": false
            },
            "verifying": {
              "type": "object",
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "lines": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "seconds": {
                  "type": "number"
                }
              },
              "required": [
                "enabled",
                "lines",
                "seconds"
              ],
              "additionalProperties": false
            },
            "scoring": {
              "type": "object",
              "properties": {
                "threshold": {
                  "type": "number"
                },
                "maxScore": {
                  "type": "number"
                }
              },
              "required": [
                "threshold",
                "maxScore"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "intro",
            "contactPosition",
            "steps",
            "contact",
            "commitment",
            "verifying",
            "scoring"
          ],
          "additionalProperties": false
        },
        "booking": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "nullable": true
            },
            "provider": {
              "type": "string",
              "enum": [
                "link",
                "google",
                "auto",
                "calendly",
                "cal_com",
                "gohighlevel",
                "hubspot",
                "tidycal",
                "acuity",
                "zoho",
                "youcanbookme",
                "savvycal",
                "microsoft"
              ]
            },
            "mode": {
              "type": "string",
              "enum": [
                "inline",
                "newTab"
              ]
            },
            "headline": {
              "type": "string"
            },
            "sub": {
              "type": "string",
              "nullable": true
            },
            "bullets": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "hostName": {
              "type": "string",
              "nullable": true
            },
            "minutes": {
              "type": "number",
              "nullable": true
            },
            "noFitLine": {
              "type": "string",
              "nullable": true
            },
            "scarcity": {
              "type": "string",
              "nullable": true
            },
            "prefill": {
              "type": "boolean"
            },
            "passAnswers": {
              "type": "boolean"
            },
            "continueLabel": {
              "type": "string"
            },
            "showRating": {
              "type": "boolean"
            }
          },
          "required": [
            "url",
            "provider",
            "mode",
            "headline",
            "sub",
            "bullets",
            "hostName",
            "minutes",
            "noFitLine",
            "scarcity",
            "prefill",
            "passAnswers",
            "continueLabel",
            "showRating"
          ],
          "additionalProperties": false
        },
        "thankYou": {
          "type": "object",
          "properties": {
            "sections": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "faq",
                      "urgency",
                      "confirm",
                      "notFor",
                      "pain",
                      "logos",
                      "agenda",
                      "bridge",
                      "mechanism",
                      "proofItems",
                      "benefits",
                      "callPitch",
                      "bookingInline",
                      "letter",
                      "fascinations",
                      "steps",
                      "founder",
                      "authority",
                      "closing",
                      "nextSteps",
                      "prepVideo",
                      "prepare",
                      "team",
                      "caseStudies",
                      "bonus",
                      "signoff"
                    ]
                  },
                  "enabled": {
                    "type": "boolean"
                  },
                  "data": {
                    "type": "object",
                    "additionalProperties": {}
                  }
                },
                "required": [
                  "id",
                  "type",
                  "enabled",
                  "data"
                ],
                "additionalProperties": false
              }
            },
            "showAddToCalendar": {
              "type": "boolean"
            },
            "showConfirmAttendance": {
              "type": "boolean"
            }
          },
          "required": [
            "sections",
            "showAddToCalendar",
            "showConfirmAttendance"
          ],
          "additionalProperties": false
        },
        "notFit": {
          "type": "object",
          "properties": {
            "headline": {
              "type": "string"
            },
            "body": {
              "type": "string"
            },
            "reapplyWhen": {
              "type": "string",
              "nullable": true
            },
            "resourceLabel": {
              "type": "string",
              "nullable": true
            },
            "resourceUrl": {
              "type": "string",
              "nullable": true
            },
            "showRating": {
              "type": "boolean"
            }
          },
          "required": [
            "headline",
            "body",
            "reapplyWhen",
            "resourceLabel",
            "resourceUrl",
            "showRating"
          ],
          "additionalProperties": false
        },
        "legal": {
          "type": "object",
          "properties": {
            "companyLine": {
              "type": "string"
            },
            "platformDisclaimer": {
              "type": "boolean"
            },
            "earningsDisclaimer": {
              "type": "boolean"
            },
            "privacyUrl": {
              "type": "string",
              "nullable": true
            },
            "termsUrl": {
              "type": "string",
              "nullable": true
            },
            "privacyText": {
              "type": "string",
              "nullable": true
            },
            "termsText": {
              "type": "string",
              "nullable": true
            },
            "footerNote": {
              "type": "string",
              "nullable": true
            },
            "sources": {
              "type": "boolean"
            }
          },
          "required": [
            "companyLine",
            "platformDisclaimer",
            "earningsDisclaimer",
            "privacyUrl",
            "termsUrl",
            "privacyText",
            "termsText",
            "footerNote",
            "sources"
          ],
          "additionalProperties": false
        },
        "seo": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "ogImageUrl": {
              "type": "string",
              "nullable": true
            },
            "indexable": {
              "type": "boolean"
            }
          },
          "required": [
            "title",
            "description",
            "ogImageUrl",
            "indexable"
          ],
          "additionalProperties": false
        },
        "tracking": {
          "type": "object",
          "properties": {
            "metaPixelId": {
              "type": "string",
              "nullable": true
            },
            "ga4MeasurementId": {
              "type": "string",
              "nullable": true
            }
          },
          "required": [
            "metaPixelId",
            "ga4MeasurementId"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "version",
        "funnel",
        "theme",
        "header",
        "cta",
        "video",
        "proof",
        "hero",
        "sections",
        "watch",
        "form",
        "booking",
        "thankYou",
        "notFit",
        "legal",
        "seo",
        "tracking"
      ],
      "additionalProperties": false
    },
    "scripts": {
      "type": "object",
      "properties": {
        "vsl": {
          "type": "object",
          "properties": {
            "beats": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "enum": [
                      "faq",
                      "cta",
                      "offer",
                      "proof",
                      "guarantee",
                      "mechanism",
                      "hook",
                      "callout",
                      "problem",
                      "mistakes"
                    ]
                  },
                  "text": {
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "text"
                ],
                "additionalProperties": false
              }
            },
            "wordCount": {
              "type": "number"
            },
            "targetMinutes": {
              "type": "number"
            }
          },
          "required": [
            "beats",
            "wordCount",
            "targetMinutes"
          ],
          "additionalProperties": false,
          "nullable": true
        },
        "prep": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            },
            "wordCount": {
              "type": "number"
            }
          },
          "required": [
            "text",
            "wordCount"
          ],
          "additionalProperties": false,
          "nullable": true
        },
        "demo": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            },
            "wordCount": {
              "type": "number"
            }
          },
          "required": [
            "text",
            "wordCount"
          ],
          "additionalProperties": false,
          "nullable": true
        }
      },
      "required": [
        "vsl",
        "prep",
        "demo"
      ],
      "additionalProperties": false
    },
    "unitsSpent": {
      "type": "number"
    },
    "generationId": {
      "type": "string"
    },
    "used": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "next": {
      "type": "string",
      "enum": [
        "page",
        "section",
        "part",
        "script",
        "funnel",
        "thankYou"
      ],
      "nullable": true
    }
  },
  "required": [
    "ok",
    "scope",
    "document",
    "scripts",
    "unitsSpent",
    "generationId",
    "used",
    "limit",
    "next"
  ],
  "additionalProperties": false
}
POST /api/v1/landers/{lander_id}/publicationsPublish a landing page

Requires a claimed subdomain, a booking link, a headline, a button label, and a free live slot on the plan. Non-blocking findings, such as a page with no video, come back in the result.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "warnings",
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/landers/{lander_id}/publicationTake a landing page offline

The page stops resolving; nothing is deleted and publishing again restores it. Any advert still pointing at the URL lands on a not-found page.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/landers/{lander_id}Delete a landing page

Permanent, and refused while the page is published. Leads it captured are kept and keep their answers.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/landers/{lander_id}/analyticsGet the funnel for one landing page

Views, video plays, watch depth, form starts, partial and complete applications, how many qualified, and how many booked, over a 1, 7, or 30 day window, with the sources and campaigns behind them.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "window": {
      "description": "Days of history. Default 7.",
      "type": "string",
      "enum": [
        "1",
        "7",
        "30"
      ]
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "visitors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "furthestStep": {
            "type": "string",
            "nullable": true
          },
          "watchedPct": {
            "type": "number",
            "nullable": true
          },
          "qualified": {
            "type": "boolean",
            "nullable": true
          },
          "label": {
            "type": "string"
          },
          "visits": {
            "type": "number"
          },
          "firstSeen": {
            "type": "string"
          },
          "lastSeen": {
            "type": "string"
          },
          "device": {
            "type": "string",
            "nullable": true
          },
          "source": {
            "type": "string"
          },
          "returning": {
            "type": "boolean"
          }
        },
        "required": [
          "furthestStep",
          "watchedPct",
          "qualified",
          "label",
          "visits",
          "firstSeen",
          "lastSeen",
          "device",
          "source",
          "returning"
        ],
        "additionalProperties": false
      }
    },
    "funnel": {
      "type": "object",
      "properties": {
        "views": {
          "type": "number"
        },
        "videoPlays": {
          "type": "number"
        },
        "watchDepth": {
          "type": "object",
          "properties": {
            "p25": {
              "type": "number"
            },
            "p50": {
              "type": "number"
            },
            "p75": {
              "type": "number"
            },
            "p100": {
              "type": "number"
            }
          },
          "required": [
            "p25",
            "p50",
            "p75",
            "p100"
          ],
          "additionalProperties": false
        },
        "medianWatchedPct": {
          "type": "number",
          "nullable": true
        },
        "formStarts": {
          "type": "number"
        },
        "partials": {
          "type": "number"
        },
        "submits": {
          "type": "number"
        },
        "qualified": {
          "type": "number"
        },
        "disqualified": {
          "type": "number"
        },
        "booked": {
          "type": "number"
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "count": {
                "type": "number"
              },
              "pctOfPrevious": {
                "type": "number"
              }
            },
            "required": [
              "label",
              "count",
              "pctOfPrevious"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "views",
        "videoPlays",
        "watchDepth",
        "medianWatchedPct",
        "formStarts",
        "partials",
        "submits",
        "qualified",
        "disqualified",
        "booked",
        "steps"
      ],
      "additionalProperties": false
    },
    "window": {
      "type": "number",
      "enum": [
        1,
        7,
        30
      ]
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "visits": {
            "type": "number"
          },
          "visitors": {
            "type": "number"
          }
        },
        "required": [
          "label",
          "visits",
          "visitors"
        ],
        "additionalProperties": false
      }
    },
    "visits": {
      "type": "number"
    },
    "uniqueVisitors": {
      "type": "number"
    },
    "returningVisitors": {
      "type": "number"
    },
    "returnRate": {
      "type": "number"
    },
    "newVisitors": {
      "type": "number"
    },
    "timeline": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "at": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "visits": {
            "type": "number"
          },
          "visitors": {
            "type": "number"
          }
        },
        "required": [
          "at",
          "label",
          "visits",
          "visitors"
        ],
        "additionalProperties": false
      }
    },
    "campaigns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "visits": {
            "type": "number"
          },
          "visitors": {
            "type": "number"
          }
        },
        "required": [
          "label",
          "visits",
          "visitors"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "visitors",
    "funnel",
    "window",
    "sources",
    "visits",
    "uniqueVisitors",
    "returningVisitors",
    "returnRate",
    "newVisitors",
    "timeline",
    "campaigns"
  ],
  "additionalProperties": false
}
POST /api/v1/lander-leads/{lead_id}/conversionsConvert a landing page lead into a client

Creates a client with status lead, linking an existing client when the email already belongs to one, and prepares their onboarding form. The lead keeps its answers.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/landers/{lander_id}/factsReplace the facts a landing page is written from

The brief the AI writes from: offer, audience, proof, and the rest. Saving facts does not rewrite the page; ask for a generation afterwards to use them. Missing fields fall back to empty, so read the lander first and send its facts back changed.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "facts": {
      "type": "object",
      "properties": {
        "offer": {
          "default": {},
          "type": "object",
          "properties": {
            "name": {
              "default": "",
              "type": "string",
              "maxLength": 120
            },
            "whatItDoes": {
              "default": "",
              "type": "string",
              "maxLength": 600
            },
            "deliverables": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 200
              }
            },
            "mechanismName": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "integrations": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 60
              }
            },
            "goLiveDays": {
              "default": null,
              "nullable": true,
              "type": "integer",
              "minimum": 0,
              "maximum": 365
            },
            "priceFrame": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 120
            },
            "capacityPerMonth": {
              "default": null,
              "nullable": true,
              "type": "integer",
              "minimum": 1,
              "maximum": 10000
            },
            "leadMagnet": {
              "default": null,
              "nullable": true,
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "maxLength": 120
                },
                "whatItIs": {
                  "type": "string",
                  "maxLength": 400
                }
              },
              "required": [
                "name",
                "whatItIs"
              ],
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        },
        "audience": {
          "default": {},
          "type": "object",
          "properties": {
            "nicheSlug": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "description": {
              "default": "",
              "type": "string",
              "maxLength": 400
            },
            "revenueBand": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "region": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "notFor": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            }
          },
          "additionalProperties": false
        },
        "pain": {
          "default": {},
          "type": "object",
          "properties": {
            "complaintsVerbatim": {
              "default": [],
              "maxItems": 6,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 300
              }
            },
            "bottleneck": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            }
          },
          "additionalProperties": false
        },
        "proof": {
          "default": {},
          "type": "object",
          "properties": {
            "results": {
              "default": [],
              "maxItems": 8,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "client": {
                    "type": "string",
                    "maxLength": 120
                  },
                  "result": {
                    "type": "string",
                    "maxLength": 200
                  },
                  "timeframe": {
                    "default": null,
                    "nullable": true,
                    "type": "string",
                    "maxLength": 60
                  }
                },
                "required": [
                  "client",
                  "result"
                ],
                "additionalProperties": false
              }
            },
            "testimonials": {
              "default": [],
              "maxItems": 50,
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "quote": {
                    "type": "string",
                    "maxLength": 800
                  },
                  "imageUrl": {
                    "nullable": true,
                    "type": "string",
                    "maxLength": 2000,
                    "format": "uri"
                  },
                  "media": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "none"
                            ]
                          }
                        },
                        "required": [
                          "kind"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "wistia"
                            ]
                          },
                          "mediaId": {
                            "type": "string",
                            "maxLength": 12,
                            "description": "Wistia hashed id, 8 to 12 lowercase letters and digits."
                          },
                          "landerMediaId": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 40
                          },
                          "poster": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 400,
                            "description": "Absolute http or https URL, or null."
                          },
                          "aspect": {
                            "default": 1.7777777777777777,
                            "type": "number",
                            "minimum": 0.2,
                            "maximum": 5
                          },
                          "autoplay": {
                            "default": false,
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "kind",
                          "mediaId"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "youtube",
                              "vimeo",
                              "loom"
                            ]
                          },
                          "url": {
                            "type": "string",
                            "maxLength": 400,
                            "description": "A YouTube, Vimeo, or Loom share URL."
                          },
                          "poster": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 400,
                            "description": "Absolute http or https URL, or null."
                          },
                          "aspect": {
                            "default": 1.7777777777777777,
                            "type": "number",
                            "minimum": 0.2,
                            "maximum": 5
                          },
                          "autoplay": {
                            "default": false,
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "kind",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "audio"
                            ]
                          },
                          "url": {
                            "type": "string",
                            "maxLength": 400,
                            "description": "Absolute http or https URL, or null."
                          },
                          "caption": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 120
                          }
                        },
                        "required": [
                          "kind",
                          "url"
                        ],
                        "additionalProperties": false
                      },
                      {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "type": "string",
                            "enum": [
                              "image"
                            ]
                          },
                          "url": {
                            "type": "string",
                            "maxLength": 400,
                            "description": "Absolute http or https URL, or null."
                          },
                          "caption": {
                            "default": null,
                            "nullable": true,
                            "type": "string",
                            "maxLength": 120
                          }
                        },
                        "required": [
                          "kind",
                          "url"
                        ],
                        "additionalProperties": false
                      }
                    ]
                  },
                  "name": {
                    "type": "string",
                    "maxLength": 80
                  },
                  "role": {
                    "default": null,
                    "nullable": true,
                    "type": "string",
                    "maxLength": 80
                  }
                },
                "required": [
                  "quote",
                  "name"
                ],
                "additionalProperties": false
              }
            },
            "logos": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 80
              }
            },
            "rating": {
              "default": null,
              "nullable": true,
              "type": "object",
              "properties": {
                "value": {
                  "type": "number",
                  "minimum": 0,
                  "maximum": 5
                },
                "count": {
                  "type": "integer",
                  "minimum": 0
                },
                "platform": {
                  "type": "string",
                  "maxLength": 40
                },
                "url": {
                  "default": null,
                  "nullable": true,
                  "type": "string",
                  "maxLength": 400
                }
              },
              "required": [
                "value",
                "count",
                "platform"
              ],
              "additionalProperties": false
            },
            "yearsOrClients": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "recordingUrl": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400
            }
          },
          "additionalProperties": false
        },
        "call": {
          "default": {},
          "type": "object",
          "properties": {
            "name": {
              "default": "",
              "type": "string",
              "maxLength": 80
            },
            "minutes": {
              "default": 30,
              "type": "integer",
              "minimum": 5,
              "maximum": 120
            },
            "host": {
              "default": "",
              "type": "string",
              "maxLength": 80
            },
            "hostRole": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 80
            },
            "hostBio": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 600
            },
            "agenda": {
              "default": [],
              "maxItems": 5,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 160
              }
            },
            "leaveWith": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 200
            },
            "guarantee": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 300
            }
          },
          "additionalProperties": false
        },
        "compliance": {
          "default": {},
          "type": "object",
          "properties": {
            "neverSay": {
              "default": [],
              "maxItems": 12,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 120
              }
            },
            "flags": {
              "default": [],
              "maxItems": 3,
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "hipaa",
                  "tcpa",
                  "financial"
                ]
              }
            }
          },
          "additionalProperties": false
        },
        "video": {
          "default": {},
          "type": "object",
          "properties": {
            "has": {
              "default": false,
              "type": "boolean"
            },
            "url": {
              "default": null,
              "nullable": true,
              "type": "string",
              "maxLength": 400
            }
          },
          "additionalProperties": false
        },
        "traffic": {
          "default": "cold_ads",
          "type": "string",
          "enum": [
            "cold_ads",
            "warm_outbound",
            "organic",
            "mixed"
          ]
        },
        "vibe": {
          "default": "clean",
          "type": "string",
          "enum": [
            "clean",
            "bold",
            "dark",
            "friendly"
          ]
        },
        "preset": {
          "default": "quiz_first",
          "type": "string",
          "enum": [
            "vsl_demo",
            "quiz_first",
            "sales_letter",
            "case_study"
          ]
        },
        "questionCount": {
          "default": null,
          "nullable": true,
          "type": "integer",
          "minimum": 0,
          "maximum": 12
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "facts"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/landers/{lander_id}/duplicatesCopy a landing page to a new draft

Copies the page, facts, and scripts to a new draft at a new link. The response carries the new lander's id.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/landers/{lander_id}/slugChange a landing page's link

Moves the page to a new path. When the page is live, the old link keeps redirecting to it, so adverts already running keep working; the response says if that redirect could not be saved.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    }
  },
  "required": [
    "slug"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/lander-website-importsRead a business website for landing page facts

Fetches one public web page and returns suggestions for a lander's brief: the offer name and what it does, the logo, the booking link, and the privacy and terms pages, where the page has them. Nothing is saved.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "The website to read, such as https://example.com."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "suggestions": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string"
        },
        "offerName": {
          "type": "string"
        },
        "whatItDoes": {
          "type": "string"
        },
        "logoUrl": {
          "type": "string"
        },
        "bookingUrl": {
          "type": "string"
        },
        "privacyUrl": {
          "type": "string"
        },
        "termsUrl": {
          "type": "string"
        }
      },
      "required": [
        "source"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "suggestions"
  ],
  "additionalProperties": false
}
GET /api/v1/lander-mediaList the agency's landing page videos

Every uploaded video with its processing status, Wistia id, thumbnail, and aspect ratio, newest first. Videos still processing are checked with Wistia first.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "ready",
              "failed",
              "queued",
              "uploading",
              "processing"
            ]
          },
          "wistia_media_id": {
            "type": "string",
            "nullable": true
          },
          "thumbnail_url": {
            "type": "string",
            "nullable": true
          },
          "aspect": {
            "type": "number",
            "nullable": true
          }
        },
        "required": [
          "id",
          "name",
          "status",
          "wistia_media_id",
          "thumbnail_url",
          "aspect"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
GET /api/v1/lander-media/{media_id}Get one landing page video's status

Checks with Wistia and returns the video's status, progress, Wistia id, thumbnail, aspect ratio, duration, and any processing error.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/lander-media/{media_id}Delete a landing page video

Permanent: the video is removed from the library and from Wistia. Refused while any landing page still uses it.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Onboarding

GET /api/v1/onboarding/formsList onboarding forms

Paginated onboarding_forms records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: onboarding:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "client_id": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string"
          },
          "niche_id": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "published",
              "archived"
            ]
          },
          "intro_copy": {
            "type": "string",
            "nullable": true
          },
          "form_index": {
            "type": "number"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "client_id",
          "name",
          "niche_id",
          "status",
          "intro_copy",
          "form_index",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/forms/{form_id}Get one onboarding forms record

Get one onboarding forms record

Permission: onboarding:view, or clients:view for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string"
    },
    "niche_id": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "published",
        "archived"
      ]
    },
    "intro_copy": {
      "type": "string",
      "nullable": true
    },
    "form_index": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "client_id",
    "name",
    "niche_id",
    "status",
    "intro_copy",
    "form_index",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/submissionsList onboarding submissions

Paginated onboarding_submissions records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: onboarding:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "client_id": {
            "type": "string",
            "nullable": true
          },
          "form_id": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "in_progress",
              "submitted",
              "invited",
              "accepted"
            ]
          },
          "invited_email": {
            "type": "string",
            "nullable": true
          },
          "data": {},
          "submitted_at": {
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "client_id",
          "form_id",
          "status",
          "invited_email",
          "data",
          "submitted_at",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/submissions/{submission_id}Get one onboarding submissions record

Get one onboarding submissions record

Permission: onboarding:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "form_id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "in_progress",
        "submitted",
        "invited",
        "accepted"
      ]
    },
    "invited_email": {
      "type": "string",
      "nullable": true
    },
    "data": {},
    "submitted_at": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "client_id",
    "form_id",
    "status",
    "invited_email",
    "data",
    "submitted_at",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/section-packsList onboarding section packs

Paginated onboarding_section_packs records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: onboarding:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "pack_key": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "blurb": {
            "type": "string"
          },
          "fields": {},
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "pack_key",
          "name",
          "title",
          "blurb",
          "fields",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/section-packs/{pack_id}Get one onboarding section packs record

Get one onboarding section packs record

Permission: onboarding:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "pack_key": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "blurb": {
      "type": "string"
    },
    "fields": {},
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "pack_key",
    "name",
    "title",
    "blurb",
    "fields",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/catalogGet niche templates, offer recipes, and question packs

Get niche templates, offer recipes, and question packs

Permission: onboarding:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "niche_templates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "section": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "number",
                    "boolean",
                    "email",
                    "phone",
                    "text",
                    "textarea",
                    "url",
                    "select",
                    "radio",
                    "multiselect",
                    "address",
                    "hours",
                    "image_upload",
                    "document_upload",
                    "color"
                  ]
                },
                "help": {
                  "type": "string"
                },
                "required": {
                  "type": "boolean"
                },
                "options": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "key",
                "section",
                "label",
                "type",
                "required"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "slug",
          "label",
          "fields"
        ],
        "additionalProperties": false
      }
    },
    "offer_templates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "intro": {
            "type": "string"
          },
          "packSlugs": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "slug",
          "name",
          "summary",
          "intro",
          "packSlugs"
        ],
        "additionalProperties": false
      }
    },
    "service_packs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "section": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "blurb": {
                "type": "string"
              }
            },
            "required": [
              "key",
              "title",
              "blurb"
            ],
            "additionalProperties": false
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "section": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "number",
                    "boolean",
                    "email",
                    "phone",
                    "text",
                    "textarea",
                    "url",
                    "select",
                    "radio",
                    "multiselect",
                    "address",
                    "hours",
                    "image_upload",
                    "document_upload",
                    "color"
                  ]
                },
                "help": {
                  "type": "string"
                },
                "required": {
                  "type": "boolean"
                },
                "options": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "key",
                "section",
                "label",
                "type",
                "required"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "slug",
          "name",
          "summary",
          "section",
          "fields"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "niche_templates",
    "offer_templates",
    "service_packs"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/formsCreate an intake form with default questions

Create an intake form with default questions

Permission: onboarding:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "intro_copy": {
      "type": "string",
      "maxLength": 2000
    },
    "niche_slug": {
      "type": "string",
      "maxLength": 64
    },
    "offer_slug": {
      "type": "string",
      "maxLength": 64
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PATCH /api/v1/onboarding/forms/{form_id}Update an intake form

Update an intake form

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "intro_copy": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "published",
        "archived"
      ]
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/onboarding/forms/{form_id}Delete an unused intake form

Forms with submissions cannot be deleted; archive them with PATCH instead.

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/forms/{form_id}/fieldsGet the ordered questions and validation rules

Get the ordered questions and validation rules

Permission: onboarding:view, or clients:view for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/forms/{form_id}/fieldsAdd a custom intake question

Add a custom intake question

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "help_text": {
      "nullable": true,
      "type": "string",
      "maxLength": 500
    },
    "field_type": {
      "type": "string",
      "enum": [
        "text",
        "textarea",
        "email",
        "url",
        "phone",
        "number",
        "select",
        "radio",
        "multiselect",
        "boolean",
        "address",
        "hours",
        "image_upload",
        "document_upload",
        "color"
      ]
    },
    "options": {
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "required": {
      "type": "boolean"
    },
    "section": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{1,62}$"
    }
  },
  "required": [
    "label",
    "help_text",
    "field_type",
    "options",
    "required",
    "section"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PATCH /api/v1/onboarding/forms/{form_id}/fields/{field_id}Update an intake question

Only supplied fields change. Core questions keep their original type and choices; hide them with enabled=false if needed.

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "help_text": {
      "nullable": true,
      "type": "string",
      "maxLength": 500
    },
    "field_type": {
      "type": "string",
      "enum": [
        "text",
        "textarea",
        "email",
        "url",
        "phone",
        "number",
        "select",
        "radio",
        "multiselect",
        "boolean",
        "address",
        "hours",
        "image_upload",
        "document_upload",
        "color"
      ]
    },
    "options": {
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "required": {
      "type": "boolean"
    },
    "section": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{1,62}$"
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/onboarding/forms/{form_id}/fields/{field_id}/visibilityShow or hide an intake question

Show or hide an intake question

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "enabled"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/onboarding/forms/{form_id}/fields/{field_id}Delete a custom or niche question

Delete a custom or niche question

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/forms/{form_id}/fields/{field_id}/movesMove a question one position up or down

Move a question one position up or down

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "direction": {
      "type": "string",
      "enum": [
        "up",
        "down"
      ]
    }
  },
  "required": [
    "direction"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/forms/{form_id}/sectionsGet the sections in a form

Get the sections in a form

Permission: onboarding:view, or clients:view for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/forms/{form_id}/sectionsAdd a question section

Add a question section

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "blurb": {
      "default": "",
      "type": "string",
      "maxLength": 240
    }
  },
  "required": [
    "title"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/onboarding/forms/{form_id}/sections/{section_id}Replace a section title and introduction

Replace a section title and introduction

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "blurb": {
      "default": "",
      "type": "string",
      "maxLength": 240
    }
  },
  "required": [
    "title"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/onboarding/forms/{form_id}/sections/{section_id}Remove a section and move its questions

Remove a section and move its questions

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/forms/{form_id}/template-applicationsApply agency, niche, or offer templates

Apply agency, niche, or offer templates

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "template_form_id": {
      "type": "string",
      "format": "uuid"
    },
    "niche_slug": {
      "type": "string",
      "maxLength": 64
    },
    "offer_slug": {
      "type": "string",
      "maxLength": 64
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/forms/{form_id}/pack-applicationsApply a service or saved section pack

Apply a service or saved section pack

Permission: onboarding:manage, or clients:manage for a client-owned form. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "custom",
        "service"
      ]
    },
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "kind",
    "slug"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/forms/{form_id}/section-pack-copiesSave an existing section as a reusable pack

Save an existing section as a reusable pack

Permission: onboarding:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "section_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    }
  },
  "required": [
    "section_key",
    "name"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/section-packsCreate a reusable question pack

Create a reusable question pack

Permission: onboarding:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "blurb": {
      "type": "string",
      "maxLength": 240
    },
    "pack_key": {
      "type": "string",
      "maxLength": 40
    },
    "fields": {
      "minItems": 1,
      "maxItems": 60,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "textarea",
              "email",
              "url",
              "phone",
              "number",
              "select",
              "radio",
              "multiselect",
              "boolean",
              "address",
              "hours",
              "image_upload",
              "document_upload",
              "color"
            ]
          },
          "required": {
            "type": "boolean"
          }
        },
        "required": [
          "key",
          "label",
          "type",
          "required"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "name",
    "fields"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/onboarding/section-packs/{pack_id}Delete a saved question pack

Delete a saved question pack

Permission: onboarding:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/submissions/{submission_id}/download-linksCreate expiring links for files attached to an intake submission

Only files already referenced by this agency's submission are signed. Arbitrary storage paths cannot be requested.

Permission: onboarding:view. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "expires_in": {
      "default": 900,
      "type": "integer",
      "minimum": 60,
      "maximum": 3600
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "files": {
          "type": "array",
          "items": {}
        },
        "expires_at": {}
      },
      "required": [
        "files",
        "expires_at"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "files": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "nullable": true
              },
              "path": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "size": {
                "type": "number"
              },
              "type": {
                "type": "string"
              },
              "field": {
                "type": "string"
              }
            },
            "required": [
              "url",
              "path",
              "name",
              "size",
              "type",
              "field"
            ],
            "additionalProperties": false
          }
        },
        "expires_at": {
          "type": "string"
        }
      },
      "required": [
        "files",
        "expires_at"
      ],
      "additionalProperties": false
    }
  ]
}

Fulfillment

GET /api/v1/fulfillment/ordersList fulfillment orders

Paginated fulfillment_requests records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "client_id": {
            "type": "string"
          },
          "submission_id": {
            "type": "string",
            "nullable": true
          },
          "fulfillment_mode": {
            "type": "string",
            "enum": [
              "lumina",
              "self"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "canceled",
              "in_progress",
              "declined",
              "submitted",
              "delivered",
              "accepted",
              "in_review"
            ]
          },
          "monthly_cents": {
            "type": "number"
          },
          "one_time_cents": {
            "type": "number"
          },
          "retail_monthly_cents": {
            "type": "number"
          },
          "retail_setup_cents": {
            "type": "number"
          },
          "free_trial_days": {
            "type": "number"
          },
          "terms": {
            "type": "string",
            "nullable": true
          },
          "currency": {
            "type": "string"
          },
          "billing_status": {
            "type": "string",
            "enum": [
              "failed",
              "active",
              "canceled",
              "pending",
              "not_billed",
              "awaiting_payment_method"
            ]
          },
          "agency_notes": {
            "type": "string",
            "nullable": true
          },
          "created_by": {
            "type": "string",
            "nullable": true
          },
          "cancel_requested_at": {
            "type": "string",
            "nullable": true
          },
          "billing_ends_at": {
            "type": "string",
            "nullable": true
          },
          "canceled_by": {
            "type": "string",
            "nullable": true
          },
          "submitted_at": {
            "type": "string",
            "nullable": true
          },
          "accepted_at": {
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "client_id",
          "submission_id",
          "fulfillment_mode",
          "status",
          "monthly_cents",
          "one_time_cents",
          "retail_monthly_cents",
          "retail_setup_cents",
          "free_trial_days",
          "terms",
          "currency",
          "billing_status",
          "agency_notes",
          "created_by",
          "cancel_requested_at",
          "billing_ends_at",
          "canceled_by",
          "submitted_at",
          "accepted_at",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/fulfillment/orders/{order_id}Get one fulfillment orders record

Get one fulfillment orders record

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "submission_id": {
      "type": "string",
      "nullable": true
    },
    "fulfillment_mode": {
      "type": "string",
      "enum": [
        "lumina",
        "self"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "canceled",
        "in_progress",
        "declined",
        "submitted",
        "delivered",
        "accepted",
        "in_review"
      ]
    },
    "monthly_cents": {
      "type": "number"
    },
    "one_time_cents": {
      "type": "number"
    },
    "retail_monthly_cents": {
      "type": "number"
    },
    "retail_setup_cents": {
      "type": "number"
    },
    "free_trial_days": {
      "type": "number"
    },
    "terms": {
      "type": "string",
      "nullable": true
    },
    "currency": {
      "type": "string"
    },
    "billing_status": {
      "type": "string",
      "enum": [
        "failed",
        "active",
        "canceled",
        "pending",
        "not_billed",
        "awaiting_payment_method"
      ]
    },
    "agency_notes": {
      "type": "string",
      "nullable": true
    },
    "created_by": {
      "type": "string",
      "nullable": true
    },
    "cancel_requested_at": {
      "type": "string",
      "nullable": true
    },
    "billing_ends_at": {
      "type": "string",
      "nullable": true
    },
    "canceled_by": {
      "type": "string",
      "nullable": true
    },
    "submitted_at": {
      "type": "string",
      "nullable": true
    },
    "accepted_at": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "client_id",
    "submission_id",
    "fulfillment_mode",
    "status",
    "monthly_cents",
    "one_time_cents",
    "retail_monthly_cents",
    "retail_setup_cents",
    "free_trial_days",
    "terms",
    "currency",
    "billing_status",
    "agency_notes",
    "created_by",
    "cancel_requested_at",
    "billing_ends_at",
    "canceled_by",
    "submitted_at",
    "accepted_at",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/fulfillment/orders/{order_id}/timelineList fulfillment timeline

Paginated fulfillment_timeline_events records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "request_id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string",
            "nullable": true
          },
          "status_at_event": {
            "type": "string",
            "nullable": true
          },
          "visibility": {
            "type": "string",
            "enum": [
              "agency",
              "client"
            ]
          },
          "occurred_at": {
            "type": "string"
          },
          "created_by": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "id",
          "request_id",
          "agency_id",
          "title",
          "body",
          "status_at_event",
          "visibility",
          "occurred_at",
          "created_by"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/fulfillment/orders/{order_id}/timeline/{id}Get one fulfillment timeline record

Get one fulfillment timeline record

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "request_id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "body": {
      "type": "string",
      "nullable": true
    },
    "status_at_event": {
      "type": "string",
      "nullable": true
    },
    "visibility": {
      "type": "string",
      "enum": [
        "agency",
        "client"
      ]
    },
    "occurred_at": {
      "type": "string"
    },
    "created_by": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "id",
    "request_id",
    "agency_id",
    "title",
    "body",
    "status_at_event",
    "visibility",
    "occurred_at",
    "created_by"
  ],
  "additionalProperties": false
}
GET /api/v1/fulfillment/interestsList fulfillment interests

Paginated fulfillment_interest records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "service_slug": {
            "type": "string"
          },
          "notes": {
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "service_slug",
          "notes",
          "created_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/fulfillment/interests/{id}Get one fulfillment interests record

Get one fulfillment interests record

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "service_slug": {
      "type": "string"
    },
    "notes": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "service_slug",
    "notes",
    "created_at"
  ],
  "additionalProperties": false
}
PUT /api/v1/fulfillment/orders/{order_id}/line-pricingReplace retail prices for every order line

Provide every current line exactly once. Amounts are integer USD cents. Line prices and order totals commit in one transaction; invalid or foreign line IDs roll back the entire change.

Permission: fulfillment:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "lines": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "monthly_cents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 100000000
          },
          "setup_cents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 100000000
          }
        },
        "required": [
          "id",
          "monthly_cents",
          "setup_cents"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "lines"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "required": [
    "message"
  ],
  "additionalProperties": false
}
GET /api/v1/fulfillment/catalogGet services, packages, add-ons, and their price guides

Every price is a wholesale guide in whole USD dollars: setup (one-time), monthly, and usage (cents per voice minute). A guide is fixed, from (and up), a range, a custom quote, optional, or a percentage of setup. Final prices are agreed on the 30-minute pricing call every order books, then locked per line before work starts.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string",
            "enum": [
              "manage",
              "agency",
              "build",
              "grow"
            ]
          },
          "summary": {
            "type": "string"
          },
          "soon": {
            "type": "boolean"
          },
          "covers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "deliverables": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "note": {
            "type": "string"
          },
          "setup": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "fixed"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "from"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "range"
                    ]
                  },
                  "min": {
                    "type": "number"
                  },
                  "max": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "min",
                  "max"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "quote"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "optional"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "percent"
                    ]
                  },
                  "percent": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "percent"
                ],
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "monthly": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "fixed"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "from"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "range"
                    ]
                  },
                  "min": {
                    "type": "number"
                  },
                  "max": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "min",
                  "max"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "quote"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "optional"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "percent"
                    ]
                  },
                  "percent": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "percent"
                ],
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "usage": {
            "type": "object",
            "properties": {
              "unit": {
                "type": "string",
                "enum": [
                  "minute"
                ]
              },
              "cents": {
                "type": "number"
              }
            },
            "required": [
              "unit",
              "cents"
            ],
            "additionalProperties": false,
            "nullable": true
          }
        },
        "required": [
          "slug",
          "name",
          "category",
          "summary",
          "soon",
          "deliverables",
          "setup",
          "monthly",
          "usage"
        ],
        "additionalProperties": false
      }
    },
    "packages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "includes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "setup": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "fixed"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "from"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "range"
                    ]
                  },
                  "min": {
                    "type": "number"
                  },
                  "max": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "min",
                  "max"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "quote"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "optional"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "percent"
                    ]
                  },
                  "percent": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "percent"
                ],
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "monthly": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "fixed"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "from"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "range"
                    ]
                  },
                  "min": {
                    "type": "number"
                  },
                  "max": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "min",
                  "max"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "quote"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "optional"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "percent"
                    ]
                  },
                  "percent": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "percent"
                ],
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "usage": {
            "type": "object",
            "properties": {
              "unit": {
                "type": "string",
                "enum": [
                  "minute"
                ]
              },
              "cents": {
                "type": "number"
              }
            },
            "required": [
              "unit",
              "cents"
            ],
            "additionalProperties": false,
            "nullable": true
          }
        },
        "required": [
          "slug",
          "name",
          "summary",
          "includes",
          "setup",
          "monthly",
          "usage"
        ],
        "additionalProperties": false
      }
    },
    "addons": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "appliesTo": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "deliverables": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "setup": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "fixed"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "from"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "range"
                    ]
                  },
                  "min": {
                    "type": "number"
                  },
                  "max": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "min",
                  "max"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "quote"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "optional"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "percent"
                    ]
                  },
                  "percent": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "percent"
                ],
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "monthly": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "fixed"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "from"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "range"
                    ]
                  },
                  "min": {
                    "type": "number"
                  },
                  "max": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "min",
                  "max"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "quote"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "optional"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "percent"
                    ]
                  },
                  "percent": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "percent"
                ],
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "usage": {
            "type": "object",
            "properties": {
              "unit": {
                "type": "string",
                "enum": [
                  "minute"
                ]
              },
              "cents": {
                "type": "number"
              }
            },
            "required": [
              "unit",
              "cents"
            ],
            "additionalProperties": false,
            "nullable": true
          }
        },
        "required": [
          "slug",
          "name",
          "summary",
          "appliesTo",
          "deliverables",
          "setup",
          "monthly",
          "usage"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "services",
    "packages",
    "addons"
  ],
  "additionalProperties": false
}
POST /api/v1/fulfillment/quotesAdd up the price guide for a fulfillment cart

Uses the current catalog and returns each line with its guide plus setup and monthly totals in whole USD dollars. Nothing here is a charge: every order is priced on a 30-minute call, and wholesale cannot be supplied by the caller.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "slugs": {
      "minItems": 1,
      "maxItems": 30,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    }
  },
  "required": [
    "slugs"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "lines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "package",
              "service",
              "addon"
            ]
          },
          "name": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "setup": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "fixed"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "from"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "range"
                    ]
                  },
                  "min": {
                    "type": "number"
                  },
                  "max": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "min",
                  "max"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "quote"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "optional"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "percent"
                    ]
                  },
                  "percent": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "percent"
                ],
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "monthly": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "fixed"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "from"
                    ]
                  },
                  "amount": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "amount"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "range"
                    ]
                  },
                  "min": {
                    "type": "number"
                  },
                  "max": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "min",
                  "max"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "quote"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "optional"
                    ]
                  }
                },
                "required": [
                  "kind"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "enum": [
                      "percent"
                    ]
                  },
                  "percent": {
                    "type": "number"
                  }
                },
                "required": [
                  "kind",
                  "percent"
                ],
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "usage": {
            "type": "object",
            "properties": {
              "unit": {
                "type": "string",
                "enum": [
                  "minute"
                ]
              },
              "cents": {
                "type": "number"
              }
            },
            "required": [
              "unit",
              "cents"
            ],
            "additionalProperties": false,
            "nullable": true
          }
        },
        "required": [
          "slug",
          "kind",
          "name",
          "label",
          "setup",
          "monthly",
          "usage"
        ],
        "additionalProperties": false
      }
    },
    "absorbed": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "setup": {
      "type": "object",
      "properties": {
        "min": {
          "type": "number"
        },
        "max": {
          "type": "number",
          "nullable": true
        },
        "quoted": {
          "type": "boolean"
        }
      },
      "required": [
        "min",
        "max",
        "quoted"
      ],
      "additionalProperties": false
    },
    "monthly": {
      "type": "object",
      "properties": {
        "min": {
          "type": "number"
        },
        "max": {
          "type": "number",
          "nullable": true
        },
        "quoted": {
          "type": "boolean"
        }
      },
      "required": [
        "min",
        "max",
        "quoted"
      ],
      "additionalProperties": false
    },
    "usage": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "unit": {
            "type": "string",
            "enum": [
              "minute"
            ]
          },
          "cents": {
            "type": "number"
          }
        },
        "required": [
          "unit",
          "cents"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "lines",
    "absorbed",
    "setup",
    "monthly",
    "usage"
  ],
  "additionalProperties": false
}
POST /api/v1/fulfillment/ordersCreate a draft order that books a pricing call

Every order is created as a draft and is sent only once its 30-minute pricing call is booked: create a booking session, book it, then post the Calendly identifiers to booking-verifications. A new client and intake form are created when client_id is omitted. Retail prices are in USD dollars. Nothing is charged until fulfillment starts.

Permission: fulfillment:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "slugs": {
      "minItems": 1,
      "maxItems": 30,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "client_id": {
      "type": "string",
      "format": "uuid"
    },
    "business_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "contact_name": {
      "type": "string",
      "maxLength": 120
    },
    "email": {
      "type": "string",
      "maxLength": 200,
      "format": "email"
    },
    "phone": {
      "type": "string",
      "maxLength": 40
    },
    "website_url": {
      "type": "string",
      "maxLength": 400,
      "format": "uri"
    },
    "retail_monthly": {
      "default": 0,
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "retail_setup": {
      "default": 0,
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "free_trial_days": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 90
    },
    "terms": {
      "type": "string",
      "maxLength": 2000
    },
    "notes": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "slugs"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "requires_booking": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "requires_booking",
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/fulfillment/orders/{order_id}/retail-pricingSet the retail price and client terms

Retail prices are USD dollars, separate from wholesale billing. This replaces both retail prices and terms.

Permission: fulfillment:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "retail_monthly": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "retail_setup": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000
    },
    "terms": {
      "nullable": true,
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "retail_monthly",
    "retail_setup",
    "terms"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/fulfillment/orders/{order_id}/cancellationsCancel a pending fulfillment request

Cancel a pending fulfillment request

Permission: fulfillment:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/fulfillment/orders/{order_id}/billing-cancellationsSchedule cancellation of a running build

Runs the existing Stripe cancellation workflow and records the paid-through date. Active service continues according to the resulting billing_ends_at.

Permission: fulfillment:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/fulfillment/orders/{order_id}/billing-cancellationResume billing for a build scheduled to cancel

Resume billing for a build scheduled to cancel

Permission: fulfillment:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/fulfillment/orders/{order_id}/items/{item_id}/billing-cancellationsCancel billing for one build line

Cancel billing for one build line

Permission: fulfillment:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/fulfillment/orders/{order_id}/items/{item_id}Remove a line from a pending request

Remove a line from a pending request

Permission: fulfillment:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/fulfillment/orders/{order_id}/itemsGet the line items and billing dates for an order

Get the line items and billing dates for an order

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
PUT /api/v1/fulfillment/interests/by-service/{service_slug}Register interest in a fulfillment service

Register interest in a fulfillment service

Permission: fulfillment:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "notes": {
      "type": "string",
      "maxLength": 1000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/fulfillment/interests/by-service/{service_slug}Withdraw fulfillment interest

Withdraw fulfillment interest

Permission: fulfillment:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Requests

GET /api/v1/requests/nichesList niche requests

Paginated niche_requests records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: requests:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "niche_name": {
            "type": "string"
          },
          "details": {
            "type": "string",
            "nullable": true
          },
          "example_business_url": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "in_progress",
              "shipped",
              "declined"
            ]
          },
          "fulfilled_niche_id": {
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "niche_name",
          "details",
          "example_business_url",
          "status",
          "fulfilled_niche_id",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/requests/niches/{id}Get one niche requests record

Get one niche requests record

Permission: requests:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "niche_name": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "example_business_url": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "in_progress",
        "shipped",
        "declined"
      ]
    },
    "fulfilled_niche_id": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "niche_name",
    "details",
    "example_business_url",
    "status",
    "fulfilled_niche_id",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/requests/nodesList node requests

Paginated node_requests records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: requests:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "node_name": {
            "type": "string"
          },
          "what_it_should_demo": {
            "type": "string"
          },
          "details": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "in_progress",
              "shipped",
              "declined"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "node_name",
          "what_it_should_demo",
          "details",
          "status",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/requests/nodes/{id}Get one node requests record

Get one node requests record

Permission: requests:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "node_name": {
      "type": "string"
    },
    "what_it_should_demo": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "in_progress",
        "shipped",
        "declined"
      ]
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "node_name",
    "what_it_should_demo",
    "details",
    "status",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/requests/nichesRequest a new niche

Request a new niche

Permission: requests:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "niche_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "details": {
      "type": "string",
      "maxLength": 2000
    },
    "example_business_url": {
      "type": "string",
      "maxLength": 400,
      "format": "uri"
    }
  },
  "required": [
    "niche_name"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/requests/nodesRequest a new demo node

Request a new demo node

Permission: requests:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "node_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "what_it_should_demo": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000
    },
    "details": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "node_name",
    "what_it_should_demo"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Usage

GET /api/v1/usage/eventsList usage events

Paginated usage_events records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: usage:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string",
            "nullable": true
          },
          "dashboard_id": {
            "type": "string",
            "nullable": true
          },
          "niche_id": {
            "type": "string",
            "nullable": true
          },
          "node_type_id": {
            "type": "string",
            "nullable": true
          },
          "kind": {
            "type": "string",
            "enum": [
              "voice_minutes",
              "chat_messages",
              "seo_audits",
              "demo_views",
              "voice_calls",
              "assistant_messages",
              "scope_sessions"
            ]
          },
          "quantity": {
            "type": "number"
          },
          "occurred_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "dashboard_id",
          "niche_id",
          "node_type_id",
          "kind",
          "quantity",
          "occurred_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/usage/events/{id}Get one usage events record

Get one usage events record

Permission: usage:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string",
      "nullable": true
    },
    "dashboard_id": {
      "type": "string",
      "nullable": true
    },
    "niche_id": {
      "type": "string",
      "nullable": true
    },
    "node_type_id": {
      "type": "string",
      "nullable": true
    },
    "kind": {
      "type": "string",
      "enum": [
        "voice_minutes",
        "chat_messages",
        "seo_audits",
        "demo_views",
        "voice_calls",
        "assistant_messages",
        "scope_sessions"
      ]
    },
    "quantity": {
      "type": "number"
    },
    "occurred_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "dashboard_id",
    "niche_id",
    "node_type_id",
    "kind",
    "quantity",
    "occurred_at"
  ],
  "additionalProperties": false
}
GET /api/v1/usage/alertsList usage alerts

Paginated usage_alerts records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: usage:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "period_start": {
            "type": "string"
          },
          "threshold": {
            "type": "number"
          },
          "sent_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "kind",
          "period_start",
          "threshold",
          "sent_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/usage/alerts/{id}Get one usage alerts record

Get one usage alerts record

Permission: usage:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    },
    "period_start": {
      "type": "string"
    },
    "threshold": {
      "type": "number"
    },
    "sent_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "kind",
    "period_start",
    "threshold",
    "sent_at"
  ],
  "additionalProperties": false
}
GET /api/v1/usageGet current usage and limits for every meter

Get current usage and limits for every meter

Permission: usage:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "kind": {
        "type": "string",
        "enum": [
          "voice_minutes",
          "chat_messages",
          "seo_audits",
          "demo_views",
          "voice_calls",
          "assistant_messages",
          "scope_sessions"
        ]
      },
      "used": {
        "type": "number"
      },
      "limit": {
        "type": "number"
      },
      "addonUnits": {
        "type": "number"
      },
      "remaining": {
        "type": "number"
      },
      "percent": {
        "type": "number"
      }
    },
    "required": [
      "kind",
      "used",
      "limit",
      "addonUnits",
      "remaining",
      "percent"
    ],
    "additionalProperties": false
  }
}

Billing

GET /api/v1/billing/usage-addon-ordersList usage addon orders

Paginated usage_addon_orders records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "units": {
            "type": "number"
          },
          "amount_cents": {
            "type": "number"
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "kind",
          "units",
          "amount_cents",
          "created_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/billing/usage-addon-orders/{id}Get one usage addon orders record

Get one usage addon orders record

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    },
    "units": {
      "type": "number"
    },
    "amount_cents": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "kind",
    "units",
    "amount_cents",
    "created_at"
  ],
  "additionalProperties": false
}
GET /api/v1/billingGet subscription and billing status

Get subscription and billing status

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "billingEnabled": {
      "type": "boolean"
    },
    "stripeConfigured": {
      "type": "boolean"
    },
    "complimentary": {
      "type": "boolean"
    },
    "plan": {
      "type": "string",
      "enum": [
        "free",
        "pro",
        "agency",
        "enterprise"
      ]
    },
    "planLabel": {
      "type": "string"
    },
    "priceUsd": {
      "type": "number",
      "nullable": true
    },
    "billingStatus": {
      "type": "string",
      "enum": [
        "inactive",
        "trialing",
        "active",
        "past_due",
        "canceled"
      ]
    },
    "currentPeriodEnd": {
      "type": "string",
      "nullable": true
    },
    "hasCustomer": {
      "type": "boolean"
    },
    "entitlements": {
      "type": "object",
      "properties": {
        "voiceMinutes": {
          "type": "number"
        },
        "chatMessages": {
          "type": "number"
        },
        "seoAudits": {
          "type": "number"
        },
        "publishedDashboards": {
          "type": "number"
        },
        "customSubdomain": {
          "type": "boolean"
        }
      },
      "required": [
        "voiceMinutes",
        "chatMessages",
        "seoAudits",
        "publishedDashboards",
        "customSubdomain"
      ],
      "additionalProperties": false
    },
    "meters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "voice_minutes",
              "chat_messages",
              "seo_audits",
              "demo_views",
              "voice_calls",
              "assistant_messages",
              "scope_sessions"
            ]
          },
          "used": {
            "type": "number"
          },
          "limit": {
            "type": "number"
          },
          "addonUnits": {
            "type": "number"
          },
          "remaining": {
            "type": "number"
          },
          "percent": {
            "type": "number"
          }
        },
        "required": [
          "kind",
          "used",
          "limit",
          "addonUnits",
          "remaining",
          "percent"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "billingEnabled",
    "stripeConfigured",
    "complimentary",
    "plan",
    "planLabel",
    "priceUsd",
    "billingStatus",
    "currentPeriodEnd",
    "hasCustomer",
    "entitlements",
    "meters"
  ],
  "additionalProperties": false
}
POST /api/v1/billing/checkout-sessionsCreate a subscription checkout session

Returns the hosted Stripe checkout URL. Agency onboarding must be complete. The API does not accept card details.

Permission: owner. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}
POST /api/v1/billing/portal-sessionsCreate a billing portal session

Returns a Stripe portal URL to manage payment methods, invoices, and the subscription.

Permission: owner. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}
GET /api/v1/billing/addon-catalogGet prices and quantities for usage add-ons

Get prices and quantities for usage add-ons

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "packs": {
      "type": "object",
      "additionalProperties": false
    },
    "bundle": {
      "type": "object",
      "properties": {
        "priceCents": {
          "type": "number"
        },
        "lines": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "voice_minutes",
                  "chat_messages",
                  "seo_audits",
                  "assistant_messages"
                ]
              },
              "units": {
                "type": "number"
              },
              "amountCents": {
                "type": "number"
              }
            },
            "required": [
              "kind",
              "units",
              "amountCents"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "priceCents",
        "lines"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "packs",
    "bundle"
  ],
  "additionalProperties": false
}
POST /api/v1/billing/addon-checkout-sessionsCreate checkout for a usage add-on

Usage is credited only after the Stripe payment webhook confirms payment. Requires an active subscription.

Permission: owner. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "voice_minutes",
        "chat_messages",
        "seo_audits",
        "assistant_messages",
        "bundle"
      ]
    }
  },
  "required": [
    "kind"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}
PUT /api/v1/billing/referral-codeApply another agency's referral code before the first payment

Apply another agency's referral code before the first payment

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "code"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": false
}

Team

GET /api/v1/team/invitationsList team invitations

Paginated agency_invites records visible to the current agency. Newest first, with ID as a stable tie-breaker.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "role": {
            "type": "string",
            "enum": [
              "member"
            ]
          },
          "permissions": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "invited_by": {
            "type": "string",
            "nullable": true
          },
          "expires_at": {
            "type": "string"
          },
          "accepted_at": {
            "type": "string",
            "nullable": true
          },
          "revoked_at": {
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "email",
          "role",
          "permissions",
          "invited_by",
          "expires_at",
          "accepted_at",
          "revoked_at",
          "created_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/team/invitations/{invitation_id}Get one team invitations record

Get one team invitations record

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "member"
      ]
    },
    "permissions": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "invited_by": {
      "type": "string",
      "nullable": true
    },
    "expires_at": {
      "type": "string"
    },
    "accepted_at": {
      "type": "string",
      "nullable": true
    },
    "revoked_at": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "email",
    "role",
    "permissions",
    "invited_by",
    "expires_at",
    "accepted_at",
    "revoked_at",
    "created_at"
  ],
  "additionalProperties": false
}
GET /api/v1/team/membersList agency members and permissions

List agency members and permissions

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
POST /api/v1/team/invitationsInvite a member to the agency

Creates a member invitation subject to the plan's seat limit and attempts delivery through the configured email provider. Returns an invitation URL even if email delivery fails. The owner role cannot be delegated.

Permission: owner. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 320,
      "format": "email"
    },
    "permissions": {
      "type": "object",
      "required": [
        "dashboards",
        "clients",
        "fulfillment",
        "onboarding",
        "brand",
        "usage",
        "blogs",
        "requests"
      ],
      "properties": {
        "dashboards": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "clients": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "fulfillment": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "onboarding": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "brand": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "usage": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "blogs": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "requests": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "email",
    "permissions"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/team/members/{user_id}/permissionsReplace a team member's permissions

Omitted scopes are removed. The owner cannot be changed through this resource.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "permissions": {
      "type": "object",
      "required": [
        "dashboards",
        "clients",
        "fulfillment",
        "onboarding",
        "brand",
        "usage",
        "blogs",
        "requests"
      ],
      "properties": {
        "dashboards": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "clients": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "fulfillment": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "onboarding": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "brand": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "usage": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "blogs": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        },
        "requests": {
          "type": "string",
          "enum": [
            "view",
            "manage"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "permissions"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/team/members/{user_id}Remove a member from the agency

Remove a member from the agency

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/team/invitations/{invitation_id}Revoke an unaccepted team invitation

Revoke an unaccepted team invitation

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/team/invitations/{invitation_id}/deliveriesResend a team invitation

Resend a team invitation

Permission: owner. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Referrals

GET /api/v1/referralsGet referral link, rewards, and partner totals

Get referral link, rewards, and partner totals

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "nullable": true
    },
    "url": {
      "type": "string",
      "nullable": true
    },
    "referrals": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    },
    "partnership": {
      "type": "object",
      "properties": {
        "referralCount": {
          "type": "number"
        },
        "monthlyRunRateCents": {
          "type": "number"
        },
        "earnedCents": {
          "type": "number"
        },
        "owedCents": {
          "type": "number"
        }
      },
      "required": [
        "referralCount",
        "monthlyRunRateCents",
        "earnedCents",
        "owedCents"
      ],
      "additionalProperties": false,
      "nullable": true
    }
  },
  "required": [
    "code",
    "url",
    "referrals",
    "partnership"
  ],
  "additionalProperties": false
}
PUT /api/v1/referrals/codeChange the agency's referral code

Old referral links stop attributing after the code changes.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "code"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Agency setup

GET /api/v1/agency/setupGet account setup progress and saved answers

Get account setup progress and saved answers

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "step": {
      "type": "number"
    },
    "completed_at": {
      "type": "string",
      "nullable": true
    },
    "next_gate": {
      "type": "string",
      "enum": [
        "onboarding",
        "subscription"
      ],
      "nullable": true
    },
    "heard_about_us": {
      "type": "string",
      "enum": [
        "youtube",
        "tiktok",
        "instagram",
        "facebook",
        "x",
        "linkedin",
        "google",
        "podcast",
        "referral",
        "coaching_community",
        "friend",
        "other"
      ],
      "nullable": true
    },
    "heard_about_us_detail": {
      "type": "string",
      "nullable": true
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "pillars": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "fulfillment",
          "onboarding",
          "live_demos",
          "client_portal",
          "white_label"
        ]
      }
    }
  },
  "required": [
    "step",
    "completed_at",
    "next_gate",
    "heard_about_us",
    "heard_about_us_detail",
    "phone",
    "pillars"
  ],
  "additionalProperties": false
}
PUT /api/v1/agency/setup/sourceComplete setup step 1: signup source

Referral, coaching community, friend, and other sources require heard_about_us_detail. Steps must be completed in order; revisiting a completed step does not reset progress.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "heard_about_us": {
      "type": "string",
      "enum": [
        "youtube",
        "tiktok",
        "instagram",
        "facebook",
        "x",
        "linkedin",
        "google",
        "podcast",
        "referral",
        "coaching_community",
        "friend",
        "other"
      ]
    },
    "heard_about_us_detail": {
      "nullable": true,
      "type": "string",
      "maxLength": 120
    }
  },
  "required": [
    "heard_about_us"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/agency/setup/profileComplete setup step 2: owner profile

Complete setup step 2: owner profile

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "full_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "phone": {
      "type": "string",
      "minLength": 8,
      "maxLength": 40
    },
    "pillars": {
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "live_demos",
          "fulfillment",
          "onboarding",
          "client_portal",
          "white_label"
        ]
      }
    }
  },
  "required": [
    "full_name",
    "phone",
    "pillars"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/agency/setup/brandComplete setup step 3: agency brand and subdomain

Complete setup step 3: agency brand and subdomain

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "subdomain": {
      "type": "string",
      "minLength": 3,
      "maxLength": 63
    },
    "primary": {
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "accent": {
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "booking_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 400,
      "format": "uri"
    },
    "website_url": {
      "nullable": true,
      "type": "string",
      "maxLength": 400,
      "format": "uri"
    },
    "contact_email": {
      "nullable": true,
      "type": "string",
      "maxLength": 200,
      "format": "email"
    },
    "tagline": {
      "type": "string",
      "maxLength": 120
    },
    "support_phone": {
      "type": "string",
      "maxLength": 40
    }
  },
  "required": [
    "name",
    "subdomain"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Assistant

GET /api/v1/assistant/toolsList Assistant server tools and their argument schemas

Only tools permitted for this member are returned. Browser draft tools require the Lumina UI and are excluded; persisted demos, forms, and embeds can be edited through their REST resources.

Permission: member. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "tools": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "parameters": {
            "type": "object",
            "additionalProperties": {}
          },
          "kind": {
            "type": "string",
            "enum": [
              "page",
              "server"
            ]
          },
          "scope": {
            "type": "string",
            "enum": [
              "dashboards",
              "clients",
              "fulfillment",
              "onboarding",
              "brand",
              "usage",
              "blogs",
              "requests"
            ]
          },
          "level": {
            "type": "string",
            "enum": [
              "view",
              "manage"
            ]
          },
          "gated": {
            "type": "boolean"
          },
          "mutates": {
            "type": "boolean"
          },
          "page": {
            "type": "string"
          },
          "internal": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "description",
          "parameters",
          "kind"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "enabled",
    "tools"
  ],
  "additionalProperties": false
}
POST /api/v1/assistant/turnsStream one Assistant model step

Returns text/event-stream. Each data line is a JSON event with type turn, text, tool_calls, usage, done, or error. Keep the turn token and full transcript across steps of one messageId. Execute returned server calls through /assistant/tool-executions, append their results, then request another step. Each message is metered once; a turn allows at most 20 model steps. Cancellation aborts the upstream model request.

Permission: member. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string",
      "format": "uuid"
    },
    "transcript": {
      "minItems": 1,
      "maxItems": 160,
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "enum": [
                  "user"
                ]
              },
              "content": {
                "type": "string",
                "minLength": 1,
                "maxLength": 4000
              }
            },
            "required": [
              "role",
              "content"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "enum": [
                  "assistant"
                ]
              },
              "content": {
                "nullable": true,
                "type": "string",
                "maxLength": 40000
              },
              "toolCalls": {
                "maxItems": 20,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    "name": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 100
                    },
                    "args": {
                      "type": "object",
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "args"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "role",
              "content"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "enum": [
                  "tool"
                ]
              },
              "toolCallId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "content": {
                "type": "string",
                "maxLength": 20000
              }
            },
            "required": [
              "role",
              "toolCallId",
              "name",
              "content"
            ],
            "additionalProperties": false
          }
        ]
      }
    },
    "turnToken": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "messageId",
    "transcript"
  ],
  "additionalProperties": false
}

Stream response

data: {"type":"text","delta":"Hello"}

data: {"type":"done","finishReason":"stop"}

POST /api/v1/assistant/tool-executionsExecute a server tool or request its confirmation

Returns status done, needs_confirmation, or error. For needs_confirmation, review the summary and warnings, then resubmit identical arguments with confirmationId. Member permissions, audit logging, and undo snapshots use the same executor as the app.

Permission: member. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string",
      "format": "uuid"
    },
    "callId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "args": {
      "type": "object",
      "additionalProperties": {}
    },
    "confirmationId": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "messageId",
    "callId",
    "name",
    "args"
  ],
  "additionalProperties": false
}

Response data schema

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "done"
          ]
        },
        "result": {
          "type": "object",
          "properties": {
            "ok": {
              "type": "boolean"
            },
            "summary": {
              "type": "string"
            },
            "state": {},
            "focus": {
              "type": "string"
            },
            "error": {
              "type": "string"
            }
          },
          "required": [
            "ok",
            "summary"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "status",
        "result"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "needs_confirmation"
          ]
        },
        "confirmation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "summary": {
              "type": "string"
            },
            "warnings": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "expiresAt": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "summary",
            "warnings",
            "expiresAt"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "status",
        "confirmation"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "error"
          ]
        },
        "error": {
          "type": "string"
        }
      },
      "required": [
        "status",
        "error"
      ],
      "additionalProperties": false
    }
  ]
}
POST /api/v1/assistant/undosPreview or undo changes made by an Assistant message

Start with confirm=false and inspect the result before sending confirm=true. The shared undo engine checks the caller and agency, detects later edits, and restores only reversible actions.

Permission: member. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string",
      "format": "uuid"
    },
    "confirm": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "messageId"
  ],
  "additionalProperties": false
}

Response data schema

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "done"
          ]
        },
        "restored": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "status",
        "restored"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "needs_confirmation"
          ]
        },
        "summary": {
          "type": "string"
        }
      },
      "required": [
        "status",
        "summary"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "nothing"
          ]
        }
      },
      "required": [
        "status"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "error"
          ]
        },
        "error": {
          "type": "string"
        }
      },
      "required": [
        "status",
        "error"
      ],
      "additionalProperties": false
    }
  ]
}
GET /api/v1/assistant/activityList your Assistant action history

List your Assistant action history

Permission: member. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    },
    "total": {
      "type": "number"
    }
  },
  "required": [
    "limit",
    "offset",
    "items",
    "total"
  ],
  "additionalProperties": false
}

Fulfillment bookings

GET /api/v1/fulfillment/booking-availabilityGet available pricing-call times

Both timestamps must be in the future and at most seven days apart. Requires configured Calendly API credentials. Returned scheduling URLs can be used to select a time; create an order booking session to include the required order tracking.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "start_time": {
      "type": "string",
      "format": "date-time"
    },
    "end_time": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "start_time",
    "end_time"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "times": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string"
          },
          "start_time": {
            "type": "string"
          },
          "scheduling_url": {
            "type": "string"
          },
          "invitees_remaining": {
            "type": "number"
          }
        },
        "required": [
          "status",
          "start_time",
          "scheduling_url",
          "invitees_remaining"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "times"
  ],
  "additionalProperties": false
}
POST /api/v1/fulfillment/orders/{order_id}/booking-sessionsCreate a tracked pricing-call booking link

Every order books a 30-minute pricing call before it is sent. Book using this exact URL so the attendee email and signed order tracking are retained. After Calendly returns event and invitee identifiers, POST them to this order's booking-verifications resource; if the Calendly webhook is configured, a completed booking also sends the order on its own. A link alone does not send the order. Calendly sends the meeting invitations when the attendee completes booking.

Permission: fulfillment:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "booking_url": {
      "type": "string"
    },
    "attendee_email": {
      "type": "string"
    },
    "verification_available": {
      "type": "boolean"
    }
  },
  "required": [
    "booking_url",
    "attendee_email",
    "verification_available"
  ],
  "additionalProperties": false
}
POST /api/v1/fulfillment/orders/{order_id}/booking-verificationsVerify a Calendly booking and send the order

Fetches the event and invitee from Calendly, checks the attendee, signed order tracking, configured event type, and active future time, then saves the booking and sends the order in one transaction. Repeat verification of the same booking is safe. Canceling the call puts an order that has not been accepted back to draft until a new time is booked; it never cancels billing.

Permission: fulfillment:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{8,100}$"
    },
    "invitee_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{8,100}$"
    }
  },
  "required": [
    "event_id",
    "invitee_id"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string"
    },
    "submitted": {
      "type": "boolean"
    },
    "booking": {
      "type": "object",
      "properties": {
        "invitee_uri": {
          "type": "string"
        },
        "event_uri": {
          "type": "string"
        },
        "event_type_uri": {
          "type": "string"
        },
        "invitee_email": {
          "type": "string"
        },
        "join_url": {
          "type": "string",
          "nullable": true
        },
        "start_time": {
          "type": "string"
        },
        "end_time": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "canceled"
          ]
        },
        "cancel_url": {
          "type": "string",
          "nullable": true
        },
        "reschedule_url": {
          "type": "string",
          "nullable": true
        }
      },
      "required": [
        "invitee_uri",
        "event_uri",
        "event_type_uri",
        "invitee_email",
        "join_url",
        "start_time",
        "end_time",
        "status",
        "cancel_url",
        "reschedule_url"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "request_id",
    "submitted",
    "booking"
  ],
  "additionalProperties": false
}
GET /api/v1/fulfillment/orders/{order_id}/bookingGet the verified pricing-call booking and cancellation or rescheduling links

Reads the saved booking and brings it in line with Calendly: a rescheduled call is followed to its new time, and a canceled one is recorded. Returns checked_at for the provider check. Calendar cancellation and rescheduling use the provider's attendee-specific links; order cancellation is a separate operation.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "checked_at": {
      "type": "string"
    },
    "invitee_uri": {
      "type": "string"
    },
    "event_uri": {
      "type": "string"
    },
    "event_type_uri": {
      "type": "string"
    },
    "invitee_email": {
      "type": "string"
    },
    "join_url": {
      "type": "string",
      "nullable": true
    },
    "start_time": {
      "type": "string"
    },
    "end_time": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "canceled"
      ]
    },
    "cancel_url": {
      "type": "string",
      "nullable": true
    },
    "reschedule_url": {
      "type": "string",
      "nullable": true
    },
    "request_id": {
      "type": "string"
    }
  },
  "required": [
    "checked_at",
    "invitee_uri",
    "event_uri",
    "event_type_uri",
    "invitee_email",
    "join_url",
    "start_time",
    "end_time",
    "status",
    "cancel_url",
    "reschedule_url",
    "request_id"
  ],
  "additionalProperties": false
}

Blogs

GET /api/v1/blogsList generated blog posts

Returns this agency's Blog library. Use the export endpoint for Markdown or DOCX files.

Permission: blogs:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "status": {
      "type": "string",
      "enum": [
        "generating",
        "ready",
        "draft",
        "failed",
        "archived"
      ]
    },
    "search": {
      "type": "string",
      "maxLength": 200
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "posts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "agency_id": {
            "type": "string"
          },
          "schedule_id": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "topic": {
            "type": "string"
          },
          "content_type": {
            "type": "string",
            "enum": [
              "how_to",
              "thought_leadership",
              "comparison",
              "case_study",
              "list",
              "guide"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "archived",
              "generating",
              "ready",
              "failed"
            ]
          },
          "excerpt": {
            "type": "string"
          },
          "markdown": {
            "type": "string"
          },
          "seo_title": {
            "type": "string"
          },
          "seo_description": {
            "type": "string"
          },
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "source_notes": {
            "type": "string"
          },
          "target_word_count": {
            "type": "number"
          },
          "actual_word_count": {
            "type": "number"
          },
          "credit_cost": {
            "type": "number"
          },
          "origin": {
            "type": "string",
            "enum": [
              "dashboard",
              "api",
              "mcp",
              "schedule"
            ]
          },
          "idempotency_key": {
            "type": "string",
            "nullable": true
          },
          "error_message": {
            "type": "string",
            "nullable": true
          },
          "generated_at": {
            "type": "string",
            "nullable": true
          },
          "delivered_at": {
            "type": "string",
            "nullable": true
          },
          "created_by": {
            "type": "string",
            "nullable": true
          },
          "updated_by": {
            "type": "string",
            "nullable": true
          },
          "version": {
            "type": "number"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "agency_id",
          "schedule_id",
          "title",
          "slug",
          "topic",
          "content_type",
          "status",
          "excerpt",
          "markdown",
          "seo_title",
          "seo_description",
          "keywords",
          "source_notes",
          "target_word_count",
          "actual_word_count",
          "credit_cost",
          "origin",
          "idempotency_key",
          "error_message",
          "generated_at",
          "delivered_at",
          "created_by",
          "updated_by",
          "version",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    }
  },
  "required": [
    "posts",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/blogs/{blog_id}Get one blog post

Get one blog post

Permission: blogs:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "schedule_id": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "topic": {
      "type": "string"
    },
    "content_type": {
      "type": "string",
      "enum": [
        "how_to",
        "thought_leadership",
        "comparison",
        "case_study",
        "list",
        "guide"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "archived",
        "generating",
        "ready",
        "failed"
      ]
    },
    "excerpt": {
      "type": "string"
    },
    "markdown": {
      "type": "string"
    },
    "seo_title": {
      "type": "string"
    },
    "seo_description": {
      "type": "string"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "source_notes": {
      "type": "string"
    },
    "target_word_count": {
      "type": "number"
    },
    "actual_word_count": {
      "type": "number"
    },
    "credit_cost": {
      "type": "number"
    },
    "origin": {
      "type": "string",
      "enum": [
        "dashboard",
        "api",
        "mcp",
        "schedule"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "nullable": true
    },
    "error_message": {
      "type": "string",
      "nullable": true
    },
    "generated_at": {
      "type": "string",
      "nullable": true
    },
    "delivered_at": {
      "type": "string",
      "nullable": true
    },
    "created_by": {
      "type": "string",
      "nullable": true
    },
    "updated_by": {
      "type": "string",
      "nullable": true
    },
    "version": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "schedule_id",
    "title",
    "slug",
    "topic",
    "content_type",
    "status",
    "excerpt",
    "markdown",
    "seo_title",
    "seo_description",
    "keywords",
    "source_notes",
    "target_word_count",
    "actual_word_count",
    "credit_cost",
    "origin",
    "idempotency_key",
    "error_message",
    "generated_at",
    "delivered_at",
    "created_by",
    "updated_by",
    "version",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/blogs/generateGenerate one brand-trained blog post

Creates exactly one post. A successful post spends one Lumina AI credit. Send Idempotency-Key when retrying.

Permission: blogs:manage. Success: 201. Maximum body: 16384 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "minLength": 3,
      "maxLength": 500
    },
    "contentType": {
      "default": "how_to",
      "type": "string",
      "enum": [
        "how_to",
        "thought_leadership",
        "comparison",
        "case_study",
        "list",
        "guide"
      ]
    },
    "targetWordCount": {
      "default": 1200,
      "type": "integer",
      "minimum": 600,
      "maximum": 3000
    },
    "notes": {
      "default": "",
      "type": "string",
      "maxLength": 3000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "post": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "agency_id": {
          "type": "string"
        },
        "schedule_id": {
          "type": "string",
          "nullable": true
        },
        "title": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "topic": {
          "type": "string"
        },
        "content_type": {
          "type": "string",
          "enum": [
            "how_to",
            "thought_leadership",
            "comparison",
            "case_study",
            "list",
            "guide"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "draft",
            "archived",
            "generating",
            "ready",
            "failed"
          ]
        },
        "excerpt": {
          "type": "string"
        },
        "markdown": {
          "type": "string"
        },
        "seo_title": {
          "type": "string"
        },
        "seo_description": {
          "type": "string"
        },
        "keywords": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "source_notes": {
          "type": "string"
        },
        "target_word_count": {
          "type": "number"
        },
        "actual_word_count": {
          "type": "number"
        },
        "credit_cost": {
          "type": "number"
        },
        "origin": {
          "type": "string",
          "enum": [
            "dashboard",
            "api",
            "mcp",
            "schedule"
          ]
        },
        "idempotency_key": {
          "type": "string",
          "nullable": true
        },
        "error_message": {
          "type": "string",
          "nullable": true
        },
        "generated_at": {
          "type": "string",
          "nullable": true
        },
        "delivered_at": {
          "type": "string",
          "nullable": true
        },
        "created_by": {
          "type": "string",
          "nullable": true
        },
        "updated_by": {
          "type": "string",
          "nullable": true
        },
        "version": {
          "type": "number"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "agency_id",
        "schedule_id",
        "title",
        "slug",
        "topic",
        "content_type",
        "status",
        "excerpt",
        "markdown",
        "seo_title",
        "seo_description",
        "keywords",
        "source_notes",
        "target_word_count",
        "actual_word_count",
        "credit_cost",
        "origin",
        "idempotency_key",
        "error_message",
        "generated_at",
        "delivered_at",
        "created_by",
        "updated_by",
        "version",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false
    },
    "delivery": {
      "type": "object",
      "properties": {
        "delivered": {
          "type": "boolean"
        },
        "error": {
          "type": "string"
        }
      },
      "required": [
        "delivered"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "post",
    "delivery"
  ],
  "additionalProperties": false
}
PATCH /api/v1/blogs/{blog_id}Update a blog post

Uses expectedVersion for conflict protection. Regeneration is a separate, metered operation.

Permission: blogs:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160,
      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
    },
    "excerpt": {
      "type": "string",
      "maxLength": 500
    },
    "markdown": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100000
    },
    "seo_title": {
      "type": "string",
      "maxLength": 200
    },
    "seo_description": {
      "type": "string",
      "maxLength": 320
    },
    "keywords": {
      "maxItems": 30,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      }
    },
    "source_notes": {
      "type": "string",
      "maxLength": 5000
    },
    "status": {
      "type": "string",
      "enum": [
        "ready",
        "draft",
        "archived"
      ]
    },
    "expectedVersion": {
      "type": "integer",
      "minimum": 0,
      "exclusiveMinimum": true
    }
  },
  "required": [
    "expectedVersion"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agency_id": {
      "type": "string"
    },
    "schedule_id": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "topic": {
      "type": "string"
    },
    "content_type": {
      "type": "string",
      "enum": [
        "how_to",
        "thought_leadership",
        "comparison",
        "case_study",
        "list",
        "guide"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "archived",
        "generating",
        "ready",
        "failed"
      ]
    },
    "excerpt": {
      "type": "string"
    },
    "markdown": {
      "type": "string"
    },
    "seo_title": {
      "type": "string"
    },
    "seo_description": {
      "type": "string"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "source_notes": {
      "type": "string"
    },
    "target_word_count": {
      "type": "number"
    },
    "actual_word_count": {
      "type": "number"
    },
    "credit_cost": {
      "type": "number"
    },
    "origin": {
      "type": "string",
      "enum": [
        "dashboard",
        "api",
        "mcp",
        "schedule"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "nullable": true
    },
    "error_message": {
      "type": "string",
      "nullable": true
    },
    "generated_at": {
      "type": "string",
      "nullable": true
    },
    "delivered_at": {
      "type": "string",
      "nullable": true
    },
    "created_by": {
      "type": "string",
      "nullable": true
    },
    "updated_by": {
      "type": "string",
      "nullable": true
    },
    "version": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agency_id",
    "schedule_id",
    "title",
    "slug",
    "topic",
    "content_type",
    "status",
    "excerpt",
    "markdown",
    "seo_title",
    "seo_description",
    "keywords",
    "source_notes",
    "target_word_count",
    "actual_word_count",
    "credit_cost",
    "origin",
    "idempotency_key",
    "error_message",
    "generated_at",
    "delivered_at",
    "created_by",
    "updated_by",
    "version",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
GET /api/v1/blogs/{blog_id}/exportDownload a blog file

Download a blog file

Permission: blogs:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "format": {
      "default": "markdown",
      "type": "string",
      "enum": [
        "markdown",
        "docx"
      ]
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "headers": {
      "type": "object",
      "additionalProperties": false
    },
    "ok": {
      "type": "boolean"
    },
    "redirected": {
      "type": "boolean"
    },
    "status": {
      "type": "number"
    },
    "statusText": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "default",
        "error",
        "basic",
        "cors",
        "opaque",
        "opaqueredirect"
      ]
    },
    "url": {
      "type": "string"
    },
    "body": {
      "type": "object",
      "properties": {
        "locked": {
          "type": "boolean"
        }
      },
      "required": [
        "locked"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "bodyUsed": {
      "type": "boolean"
    }
  },
  "required": [
    "headers",
    "ok",
    "redirected",
    "status",
    "statusText",
    "type",
    "url",
    "body",
    "bodyUsed"
  ],
  "additionalProperties": false
}
GET /api/v1/blogs/profileGet the brand brief blogs are written from

The niche, audience, offers, voice, keywords, source links, and writing instructions every generated post uses. Empty fields when the brief has never been saved.

Permission: blogs:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "anyOf": [
    {
      "type": "object",
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "updated_at": {},
        "niche": {
          "type": "string"
        },
        "audience": {
          "type": "string"
        },
        "offers": {
          "type": "string"
        },
        "differentiators": {
          "type": "string"
        },
        "expertise": {
          "type": "string"
        },
        "brand_voice": {
          "type": "string"
        },
        "goals": {
          "type": "string"
        },
        "call_to_action": {
          "type": "string"
        },
        "keywords": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "source_urls": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "avoid_topics": {
          "type": "string"
        },
        "instructions": {
          "type": "string"
        }
      },
      "required": [
        "updated_at",
        "niche",
        "audience",
        "offers",
        "differentiators",
        "expertise",
        "brand_voice",
        "goals",
        "call_to_action",
        "keywords",
        "source_urls",
        "avoid_topics",
        "instructions"
      ],
      "additionalProperties": false
    }
  ]
}
PUT /api/v1/blogs/profileSave the brand brief blogs are written from

Replaces the whole brief. Fields left out are saved empty, so read it first and send it back changed.

Permission: blogs:manage. Success: 200. Maximum body: 65536 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "niche": {
      "default": "",
      "type": "string",
      "maxLength": 160
    },
    "audience": {
      "default": "",
      "type": "string",
      "maxLength": 2000
    },
    "offers": {
      "default": "",
      "type": "string",
      "maxLength": 4000
    },
    "differentiators": {
      "default": "",
      "type": "string",
      "maxLength": 3000
    },
    "expertise": {
      "default": "",
      "type": "string",
      "maxLength": 3000
    },
    "brand_voice": {
      "default": "",
      "type": "string",
      "maxLength": 2000
    },
    "goals": {
      "default": "",
      "type": "string",
      "maxLength": 2000
    },
    "call_to_action": {
      "default": "",
      "type": "string",
      "maxLength": 1000
    },
    "keywords": {
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      }
    },
    "source_urls": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      }
    },
    "avoid_topics": {
      "default": "",
      "type": "string",
      "maxLength": 2000
    },
    "instructions": {
      "default": "",
      "type": "string",
      "maxLength": 5000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
GET /api/v1/blogs/scheduleGet the automatic blog schedule

How often a post is generated on its own, when the next one runs, and whether a webhook receives each post. Null when no schedule was ever saved. The webhook URL and secret are never returned.

Permission: blogs:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "cadence": {
          "type": "string",
          "enum": [
            "weekly",
            "biweekly",
            "monthly"
          ]
        },
        "weekday": {
          "type": "number"
        },
        "local_time": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "topic_brief": {
          "type": "string"
        },
        "target_word_count": {
          "type": "number"
        },
        "next_run_at": {
          "type": "string",
          "nullable": true
        },
        "last_run_at": {
          "type": "string",
          "nullable": true
        },
        "webhook_configured": {
          "type": "boolean"
        },
        "last_delivery_error": {
          "type": "string",
          "nullable": true
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "enabled",
        "cadence",
        "weekday",
        "local_time",
        "timezone",
        "topic_brief",
        "target_word_count",
        "next_run_at",
        "last_run_at",
        "webhook_configured",
        "last_delivery_error",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false,
      "nullable": true
    }
  },
  "required": [
    "schedule"
  ],
  "additionalProperties": false
}
PUT /api/v1/blogs/scheduleSave the automatic blog schedule

While enabled, a post is generated on the cadence and each one spends one Lumina AI credit. A webhook_url sends every new post there, signed. When a webhook is first set or its secret is rotated, the signing secret is returned once as webhook_secret.

Permission: blogs:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "cadence": {
      "type": "string",
      "enum": [
        "weekly",
        "biweekly",
        "monthly"
      ]
    },
    "weekday": {
      "type": "integer",
      "minimum": 0,
      "maximum": 6,
      "description": "0 is Sunday, 6 is Saturday."
    },
    "local_time": {
      "type": "string",
      "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
      "description": "24-hour HH:MM in the schedule's time zone."
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "An IANA time zone, such as America/Chicago."
    },
    "topic_brief": {
      "type": "string",
      "maxLength": 2000
    },
    "target_word_count": {
      "type": "integer",
      "minimum": 600,
      "maximum": 3000
    },
    "webhook_url": {
      "description": "HTTPS URL each new post is sent to. Leave out to keep the current one.",
      "type": "string",
      "maxLength": 2000
    },
    "remove_webhook": {
      "default": false,
      "type": "boolean"
    },
    "rotate_webhook_secret": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "enabled",
    "cadence",
    "weekday",
    "local_time",
    "timezone",
    "topic_brief",
    "target_word_count"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "schedule": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "cadence": {
          "type": "string",
          "enum": [
            "weekly",
            "biweekly",
            "monthly"
          ]
        },
        "weekday": {
          "type": "number"
        },
        "local_time": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "topic_brief": {
          "type": "string"
        },
        "target_word_count": {
          "type": "number"
        },
        "next_run_at": {
          "type": "string",
          "nullable": true
        },
        "last_run_at": {
          "type": "string",
          "nullable": true
        },
        "webhook_configured": {
          "type": "boolean"
        },
        "last_delivery_error": {
          "type": "string",
          "nullable": true
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "enabled",
        "cadence",
        "weekday",
        "local_time",
        "timezone",
        "topic_brief",
        "target_word_count",
        "next_run_at",
        "last_run_at",
        "webhook_configured",
        "last_delivery_error",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "webhook_secret": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "message",
    "schedule",
    "webhook_secret"
  ],
  "additionalProperties": false
}

Custom niches

GET /api/v1/custom-nichesList the agency's custom niches

A custom niche is a library niche forked and edited for one business: its name, services, hours, team, and its own AI voice and chat agents. Returns every one the agency owns (at most 50), newest first. agents is live when the voice and chat agents say what the niche says, pending when an edit has not reached them, syncing while an update runs, and error when the last update failed.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "base_niche_slug": {
            "type": "string"
          },
          "base_niche_name": {
            "type": "string"
          },
          "client_id": {
            "type": "string",
            "nullable": true
          },
          "business_name": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "voice_model": {
            "type": "string",
            "enum": [
              "grok-voice-3.0",
              "gpt-live-1"
            ]
          },
          "voice_name": {
            "type": "string",
            "nullable": true
          },
          "languages": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "service_count": {
            "type": "number"
          },
          "tool_count": {
            "type": "number"
          },
          "agents": {
            "type": "string",
            "enum": [
              "error",
              "pending",
              "syncing",
              "live"
            ]
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "slug",
          "name",
          "base_niche_slug",
          "base_niche_name",
          "client_id",
          "business_name",
          "city",
          "voice_model",
          "voice_name",
          "languages",
          "service_count",
          "tool_count",
          "agents",
          "updated_at"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
GET /api/v1/custom-niches/{niche_id}Get one custom niche in full

The list fields plus profile (the business, services, hours, staff, objections, the receptionist's persona, call goals, vocabulary and built-in tools), agent (voice, languages, extra instructions, prompt overrides and custom tools) and source (where the content came from, including any service names the source gave no price for). Read it before a PATCH that replaces a list.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "profile": {
      "type": "object",
      "properties": {
        "tagline": {
          "type": "string"
        },
        "voice": {
          "type": "object",
          "properties": {
            "agentName": {
              "type": "string"
            },
            "roleTitle": {
              "type": "string"
            },
            "tone": {
              "type": "string"
            },
            "greeting": {
              "type": "string"
            },
            "chatGreeting": {
              "type": "string"
            },
            "fillerPhrases": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "guardrails": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "successLine": {
              "type": "string"
            },
            "priceGuidance": {
              "type": "string"
            },
            "tryAsking": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "agentName",
            "tone",
            "greeting",
            "fillerPhrases",
            "guardrails"
          ],
          "additionalProperties": false
        },
        "hours": {
          "type": "object",
          "properties": {
            "summary": {
              "type": "string"
            },
            "weekly": {
              "type": "array",
              "items": {
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "number"
                    }
                  ]
                },
                "nullable": true
              }
            },
            "afterHoursPolicy": {
              "type": "string"
            },
            "emergencyAvailable": {
              "type": "boolean"
            }
          },
          "required": [
            "summary",
            "weekly",
            "afterHoursPolicy",
            "emergencyAvailable"
          ],
          "additionalProperties": false
        },
        "business": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "city": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "phone": {
              "type": "string"
            },
            "domain": {
              "type": "string"
            },
            "positioning": {
              "type": "string"
            },
            "yearsInBusiness": {
              "type": "number"
            }
          },
          "required": [
            "name",
            "city",
            "state",
            "phone",
            "domain",
            "positioning",
            "yearsInBusiness"
          ],
          "additionalProperties": false
        },
        "services": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "priceLow": {
                "type": "number"
              },
              "priceHigh": {
                "type": "number"
              },
              "durationMinutes": {
                "type": "number"
              },
              "isHeadline": {
                "type": "boolean"
              },
              "note": {
                "type": "string"
              },
              "priceLabel": {
                "type": "string"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "addon",
                  "visit",
                  "consult",
                  "program",
                  "product",
                  "emergency",
                  "stay"
                ]
              },
              "unit": {
                "type": "string",
                "nullable": true
              },
              "entry": {
                "type": "string",
                "nullable": true
              },
              "bookingNoun": {
                "type": "string"
              },
              "quote": {
                "type": "boolean"
              },
              "phone": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "channel": {
                "type": "string"
              },
              "walkIn": {
                "type": "boolean"
              },
              "intake": {
                "type": "object",
                "properties": {
                  "question": {
                    "type": "string"
                  },
                  "answer": {
                    "type": "string"
                  },
                  "answers": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "question",
                  "answer"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "name",
              "priceLow",
              "priceHigh",
              "durationMinutes"
            ],
            "additionalProperties": false
          }
        },
        "staff": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "handles": {
                "type": "string"
              }
            },
            "required": [
              "title",
              "name",
              "handles"
            ],
            "additionalProperties": false
          }
        },
        "objections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "concern": {
                "type": "string"
              },
              "response": {
                "type": "string"
              }
            },
            "required": [
              "concern",
              "response"
            ],
            "additionalProperties": false
          }
        },
        "callGoals": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "vocabulary": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "tools": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "check_availability",
              "book_appointment",
              "create_lead",
              "send_confirmation",
              "transfer_to_human",
              "check_hours",
              "verify_insurance",
              "lookup_patient",
              "quote_treatment",
              "check_service_area",
              "quote_job",
              "book_estimate",
              "dispatch_technician",
              "check_emergency_slot",
              "lookup_account",
              "search_listings",
              "schedule_showing",
              "estimate_home_value",
              "prequalify_borrower",
              "quote_rate",
              "quote_policy",
              "lookup_policy",
              "screen_case",
              "schedule_consultation",
              "check_filing_deadline",
              "quote_engagement",
              "lookup_vehicle",
              "quote_repair",
              "check_parts_availability",
              "check_class_schedule",
              "check_event_date",
              "book_with_stylist",
              "check_membership",
              "check_site_access",
              "schedule_site_visit",
              "check_rental_availability",
              "log_rfq",
              "lookup_order",
              "create_work_order"
            ]
          }
        },
        "nicheName": {
          "type": "string"
        },
        "kpis": {
          "type": "object",
          "properties": {
            "averageTicket": {
              "type": "number"
            },
            "lifetimeValue": {
              "type": "number"
            },
            "closeRate": {
              "type": "number"
            },
            "monthlyMissedCalls": {
              "type": "number"
            },
            "costPerLead": {
              "type": "number"
            },
            "noCallbackRate": {
              "type": "number"
            }
          },
          "additionalProperties": false
        }
      },
      "required": [
        "tagline",
        "voice",
        "hours",
        "business",
        "services",
        "staff",
        "objections",
        "callGoals",
        "vocabulary",
        "tools",
        "nicheName"
      ],
      "additionalProperties": false
    },
    "agent": {
      "type": "object",
      "properties": {
        "voiceModel": {
          "type": "string",
          "enum": [
            "grok-voice-3.0",
            "gpt-live-1"
          ]
        },
        "voiceId": {
          "type": "string"
        },
        "voiceName": {
          "type": "string"
        },
        "languages": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "voice": {
          "type": "object",
          "properties": {
            "instructions": {
              "type": "string"
            },
            "promptOverride": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "chat": {
          "type": "object",
          "properties": {
            "instructions": {
              "type": "string"
            },
            "promptOverride": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "customTools": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "parameters": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "string",
                        "number",
                        "boolean"
                      ]
                    },
                    "description": {
                      "type": "string"
                    },
                    "required": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "name",
                    "type",
                    "description"
                  ],
                  "additionalProperties": false
                }
              },
              "filler": {
                "type": "string"
              },
              "result": {
                "type": "string"
              }
            },
            "required": [
              "name",
              "label",
              "description",
              "parameters",
              "filler",
              "result"
            ],
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    },
    "source": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "description",
            "website",
            "fork"
          ]
        },
        "websiteUrl": {
          "type": "string"
        },
        "importedAt": {
          "type": "string"
        },
        "estimatedPrices": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "base_niche_slug": {
      "type": "string"
    },
    "base_niche_name": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "business_name": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "voice_model": {
      "type": "string",
      "enum": [
        "grok-voice-3.0",
        "gpt-live-1"
      ]
    },
    "voice_name": {
      "type": "string",
      "nullable": true
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "service_count": {
      "type": "number"
    },
    "tool_count": {
      "type": "number"
    },
    "agents": {
      "type": "string",
      "enum": [
        "error",
        "pending",
        "syncing",
        "live"
      ]
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "profile",
    "agent",
    "source",
    "id",
    "slug",
    "name",
    "base_niche_slug",
    "base_niche_name",
    "client_id",
    "business_name",
    "city",
    "voice_model",
    "voice_name",
    "languages",
    "service_count",
    "tool_count",
    "agents",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/custom-nichesCreate a custom niche from a library niche

Forks the library niche in base_niche_slug (slugs come from getDemoCatalog) and creates its voice and chat agents. business_name sets the business the AI answers as; name is the label in the agency's own list and defaults to the business name. website_url reads that site and fills the niche from it; description does the same from a sentence or two. Send at most one of them. Reading a website or a description spends one Lumina AI credit and takes about 20 seconds. Nothing is spent when the read fails. Read notes in the answer: they say which services had no price given (the AI says "quoted on request" for those until a price is set), and whether the agents are behind. An agency may own 50. To put the niche on a demo, send its id as custom_niche_id to personalizeDemo or createDemo.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "base_niche_slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "business_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "client_id": {
      "type": "string",
      "format": "uuid"
    },
    "website_url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 400
    },
    "description": {
      "type": "string",
      "minLength": 12,
      "maxLength": 4000
    }
  },
  "required": [
    "base_niche_slug"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "base_niche_slug": {
      "type": "string"
    },
    "base_niche_name": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "business_name": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "voice_model": {
      "type": "string",
      "enum": [
        "grok-voice-3.0",
        "gpt-live-1"
      ]
    },
    "voice_name": {
      "type": "string",
      "nullable": true
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "service_count": {
      "type": "number"
    },
    "tool_count": {
      "type": "number"
    },
    "agents": {
      "type": "string",
      "enum": [
        "error",
        "pending",
        "syncing",
        "live"
      ]
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "message",
    "notes",
    "id",
    "slug",
    "name",
    "base_niche_slug",
    "base_niche_name",
    "client_id",
    "business_name",
    "city",
    "voice_model",
    "voice_name",
    "languages",
    "service_count",
    "tool_count",
    "agents",
    "updated_at"
  ],
  "additionalProperties": false
}
PATCH /api/v1/custom-niches/{niche_id}Edit a custom niche and update its agents

Only the keys you send change, and saving updates the voice and chat agents itself; there is no separate publish. name renames it in the agency's list. client_id links a client, and null unlinks. profile merge rule: business, hours and voice merge key by key, so {"business":{"city":"Austin"}} changes the city and keeps the phone number. Every list replaces whole: services, staff, objections, callGoals, vocabulary and tools must be sent complete, so read the niche first and send the full new list (at most 30 services). profile.tools takes names from listDemoTools (at most 10). agent merge rule: voiceModel (the AI voice model: grok-voice-3.0 or gpt-live-1; grok-voice-3.0 is the default), voiceId (an id from listVoices whose model is the niche's model; any other id is refused, an empty string goes back to the model's default voice, and a model change without a voiceId does the same), languages (one or two codes from listLanguages; two makes the agent bilingual, opening in the first) and customTools (at most 8, replaced whole) replace what was there. agent.voice and agent.chat merge key by key: instructions is added to the generated prompt, promptOverride replaces the generated prompt outright, and an empty string clears either one. Read notes and agents in the answer: agents other than live means the edit is saved but the agents have not caught up, and syncCustomNicheAgents tries again.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "client_id": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    },
    "profile": {
      "type": "object",
      "properties": {
        "nicheName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80
        },
        "tagline": {
          "type": "string",
          "minLength": 1,
          "maxLength": 240
        },
        "business": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "city": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "state": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "phone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "domain": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "positioning": {
              "type": "string",
              "minLength": 1,
              "maxLength": 400
            },
            "yearsInBusiness": {
              "type": "integer",
              "minimum": 0,
              "maximum": 300
            }
          },
          "additionalProperties": false
        },
        "services": {
          "minItems": 1,
          "maxItems": 30,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "priceLow": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              },
              "priceHigh": {
                "type": "number",
                "minimum": 0,
                "maximum": 1000000
              },
              "durationMinutes": {
                "type": "integer",
                "minimum": 0,
                "maximum": 100000
              },
              "isHeadline": {
                "type": "boolean"
              },
              "note": {
                "type": "string",
                "maxLength": 500
              },
              "priceLabel": {
                "type": "string",
                "maxLength": 120
              },
              "kind": {
                "type": "string",
                "enum": [
                  "visit",
                  "consult",
                  "program",
                  "addon",
                  "product",
                  "emergency",
                  "stay"
                ]
              },
              "unit": {
                "nullable": true,
                "type": "string",
                "maxLength": 60
              },
              "entry": {
                "nullable": true,
                "type": "string",
                "maxLength": 120
              },
              "bookingNoun": {
                "type": "string",
                "maxLength": 40
              },
              "quote": {
                "type": "boolean"
              },
              "phone": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "channel": {
                "type": "string",
                "maxLength": 80
              },
              "walkIn": {
                "type": "boolean"
              },
              "intake": {
                "type": "object",
                "properties": {
                  "question": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 240
                  },
                  "answer": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 240
                  },
                  "answers": {
                    "maxItems": 6,
                    "type": "array",
                    "items": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 240
                    }
                  }
                },
                "required": [
                  "question",
                  "answer"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "name",
              "priceLow",
              "priceHigh",
              "durationMinutes"
            ],
            "additionalProperties": false
          }
        },
        "hours": {
          "type": "object",
          "properties": {
            "summary": {
              "type": "string",
              "minLength": 1,
              "maxLength": 240
            },
            "weekly": {
              "minItems": 7,
              "maxItems": 7,
              "type": "array",
              "items": {
                "nullable": true,
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "type": "number",
                      "minimum": 0,
                      "maximum": 24
                    },
                    {
                      "type": "number",
                      "minimum": 0,
                      "maximum": 24
                    }
                  ]
                },
                "minItems": 2,
                "maxItems": 2
              }
            },
            "afterHoursPolicy": {
              "type": "string",
              "minLength": 1,
              "maxLength": 800
            },
            "emergencyAvailable": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "staff": {
          "maxItems": 12,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "handles": {
                "type": "string",
                "minLength": 1,
                "maxLength": 240
              }
            },
            "required": [
              "title",
              "name",
              "handles"
            ],
            "additionalProperties": false
          }
        },
        "objections": {
          "maxItems": 12,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "concern": {
                "type": "string",
                "minLength": 1,
                "maxLength": 240
              },
              "response": {
                "type": "string",
                "minLength": 1,
                "maxLength": 600
              }
            },
            "required": [
              "concern",
              "response"
            ],
            "additionalProperties": false
          }
        },
        "voice": {
          "type": "object",
          "properties": {
            "agentName": {
              "type": "string",
              "minLength": 1,
              "maxLength": 40
            },
            "roleTitle": {
              "type": "string",
              "maxLength": 60
            },
            "tone": {
              "type": "string",
              "minLength": 1,
              "maxLength": 800
            },
            "greeting": {
              "type": "string",
              "minLength": 1,
              "maxLength": 400
            },
            "chatGreeting": {
              "type": "string",
              "maxLength": 400
            },
            "fillerPhrases": {
              "maxItems": 8,
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              }
            },
            "guardrails": {
              "maxItems": 16,
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 1000
              }
            },
            "successLine": {
              "type": "string",
              "maxLength": 700
            },
            "priceGuidance": {
              "type": "string",
              "maxLength": 1000
            },
            "tryAsking": {
              "maxItems": 6,
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 160
              }
            }
          },
          "additionalProperties": false
        },
        "callGoals": {
          "minItems": 1,
          "maxItems": 8,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 600
          }
        },
        "vocabulary": {
          "maxItems": 60,
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 60
          }
        },
        "tools": {
          "maxItems": 10,
          "type": "array",
          "items": {}
        },
        "kpis": {
          "type": "object",
          "properties": {
            "averageTicket": {
              "type": "number",
              "minimum": 0,
              "maximum": 10000000
            },
            "lifetimeValue": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000000
            },
            "closeRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 1
            },
            "monthlyMissedCalls": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000
            },
            "costPerLead": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000
            },
            "noCallbackRate": {
              "type": "number",
              "minimum": 0,
              "maximum": 1
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "agent": {
      "type": "object",
      "properties": {
        "voiceModel": {
          "type": "string",
          "enum": [
            "grok-voice-3.0",
            "gpt-live-1"
          ]
        },
        "voiceId": {
          "type": "string",
          "maxLength": 120
        },
        "languages": {
          "minItems": 1,
          "maxItems": 2,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "en-US",
              "es-419",
              "es-ES",
              "fr-CA",
              "fr-FR",
              "pt-BR",
              "pt-PT",
              "en-GB",
              "en-AU",
              "en-NZ",
              "en-IN",
              "de-DE",
              "it-IT",
              "nl-NL",
              "nl-BE",
              "zh-CN",
              "yue-CN",
              "ja-JP",
              "ko-KR",
              "hi-IN",
              "vi-VN",
              "fil-PH",
              "ar-SA",
              "he-IL",
              "ru-RU",
              "uk-UA",
              "pl-PL",
              "tr-TR",
              "el-GR",
              "sv-SE",
              "da-DK",
              "no-NO",
              "fi-FI",
              "cs-CZ",
              "sk-SK",
              "hu-HU",
              "ro-RO",
              "bg-BG",
              "hr-HR",
              "sr-RS",
              "ca-ES",
              "id-ID",
              "ms-MY",
              "th-TH",
              "ta-IN",
              "ur-IN",
              "fa-IR",
              "sw-KE",
              "af-ZA"
            ]
          }
        },
        "voice": {
          "type": "object",
          "properties": {
            "instructions": {
              "type": "string",
              "maxLength": 4000
            },
            "promptOverride": {
              "type": "string",
              "maxLength": 16000
            }
          },
          "additionalProperties": false
        },
        "chat": {
          "type": "object",
          "properties": {
            "instructions": {
              "type": "string",
              "maxLength": 4000
            },
            "promptOverride": {
              "type": "string",
              "maxLength": 16000
            }
          },
          "additionalProperties": false
        },
        "customTools": {
          "maxItems": 8,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{2,47}$"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 60
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 500
              },
              "parameters": {
                "maxItems": 6,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{0,39}$"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "string",
                        "number",
                        "boolean"
                      ]
                    },
                    "description": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 240
                    },
                    "required": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "name",
                    "type",
                    "description"
                  ],
                  "additionalProperties": false
                }
              },
              "filler": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "result": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              }
            },
            "required": [
              "name",
              "label",
              "description",
              "parameters",
              "filler",
              "result"
            ],
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "base_niche_slug": {
      "type": "string"
    },
    "base_niche_name": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "business_name": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "voice_model": {
      "type": "string",
      "enum": [
        "grok-voice-3.0",
        "gpt-live-1"
      ]
    },
    "voice_name": {
      "type": "string",
      "nullable": true
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "service_count": {
      "type": "number"
    },
    "tool_count": {
      "type": "number"
    },
    "agents": {
      "type": "string",
      "enum": [
        "error",
        "pending",
        "syncing",
        "live"
      ]
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "message",
    "notes",
    "id",
    "slug",
    "name",
    "base_niche_slug",
    "base_niche_name",
    "client_id",
    "business_name",
    "city",
    "voice_model",
    "voice_name",
    "languages",
    "service_count",
    "tool_count",
    "agents",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/custom-niches/{niche_id}/draftsRefill a custom niche from a website or a description

Reads website_url, or description, and lays what it finds over the niche: the business, services, hours, staff and common questions. Send exactly one of them. What the source does not say is left as it was. Reading a website or a description spends one Lumina AI credit and takes about 20 seconds. Nothing is spent when the read fails. Read notes in the answer for services with no price given.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "website_url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 400
    },
    "description": {
      "type": "string",
      "minLength": 12,
      "maxLength": 4000
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "base_niche_slug": {
      "type": "string"
    },
    "base_niche_name": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "business_name": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "voice_model": {
      "type": "string",
      "enum": [
        "grok-voice-3.0",
        "gpt-live-1"
      ]
    },
    "voice_name": {
      "type": "string",
      "nullable": true
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "service_count": {
      "type": "number"
    },
    "tool_count": {
      "type": "number"
    },
    "agents": {
      "type": "string",
      "enum": [
        "error",
        "pending",
        "syncing",
        "live"
      ]
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "message",
    "notes",
    "id",
    "slug",
    "name",
    "base_niche_slug",
    "base_niche_name",
    "client_id",
    "business_name",
    "city",
    "voice_model",
    "voice_name",
    "languages",
    "service_count",
    "tool_count",
    "agents",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/custom-niches/{niche_id}/agentsUpdate a custom niche's voice and chat agents

Brings the agents in line with what the niche says. Saving already does this, so call it only when agents is pending or error. force rebuilds them even when nothing changed. It spends no AI credit.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "force": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "base_niche_slug": {
      "type": "string"
    },
    "base_niche_name": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "business_name": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "voice_model": {
      "type": "string",
      "enum": [
        "grok-voice-3.0",
        "gpt-live-1"
      ]
    },
    "voice_name": {
      "type": "string",
      "nullable": true
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "service_count": {
      "type": "number"
    },
    "tool_count": {
      "type": "number"
    },
    "agents": {
      "type": "string",
      "enum": [
        "error",
        "pending",
        "syncing",
        "live"
      ]
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "message",
    "notes",
    "id",
    "slug",
    "name",
    "base_niche_slug",
    "base_niche_name",
    "client_id",
    "business_name",
    "city",
    "voice_model",
    "voice_name",
    "languages",
    "service_count",
    "tool_count",
    "agents",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/custom-niches/{niche_id}/copiesCopy a custom niche

Creates a second niche with the same content and agent settings, named '<name> copy', with voice and chat agents of its own. It is linked to no client and no demo.

Permission: dashboards:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "base_niche_slug": {
      "type": "string"
    },
    "base_niche_name": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "business_name": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "voice_model": {
      "type": "string",
      "enum": [
        "grok-voice-3.0",
        "gpt-live-1"
      ]
    },
    "voice_name": {
      "type": "string",
      "nullable": true
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "service_count": {
      "type": "number"
    },
    "tool_count": {
      "type": "number"
    },
    "agents": {
      "type": "string",
      "enum": [
        "error",
        "pending",
        "syncing",
        "live"
      ]
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "message",
    "notes",
    "id",
    "slug",
    "name",
    "base_niche_slug",
    "base_niche_name",
    "client_id",
    "business_name",
    "city",
    "voice_model",
    "voice_name",
    "languages",
    "service_count",
    "tool_count",
    "agents",
    "updated_at"
  ],
  "additionalProperties": false
}
DELETE /api/v1/custom-niches/{niche_id}Delete a custom niche and its agents

Permanent. Demos running on it are kept and go back to the library niche underneath, so a published demo keeps working with the stock agent. The message says how many demos that was.

Permission: dashboards:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "deleted": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "message": {
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "id",
    "deleted",
    "message"
  ],
  "additionalProperties": false
}
GET /api/v1/voicesList the voices a custom niche's receptionist can use

Each id is a value for agent.voiceId in updateCustomNiche, on the AI voice model named in its model field (set agent.voiceModel to match). Only voices on this list are accepted. preview_url is a short sample to play. The list is empty when live voice is not connected on this deployment.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "model": {
            "type": "string",
            "enum": [
              "grok-voice-3.0",
              "gpt-live-1"
            ]
          },
          "age": {
            "type": "string",
            "nullable": true
          },
          "accent": {
            "type": "string",
            "nullable": true
          },
          "gender": {
            "type": "string",
            "enum": [
              "male",
              "female"
            ],
            "nullable": true
          },
          "preview_url": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "id",
          "name",
          "provider",
          "model",
          "age",
          "accent",
          "gender",
          "preview_url"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
GET /api/v1/demo-toolsList the built-in demo tools an AI agent can call

Every one is simulated: the agent calls it, a plausible answer comes back, and nothing real is booked or sent. A name from this list goes in profile.tools in updateCustomNiche. A tool written by the agency goes in agent.customTools instead, and may not reuse a name from this list.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "category": {
            "type": "string",
            "enum": [
              "universal",
              "health",
              "home-services",
              "real-estate",
              "lending",
              "insurance",
              "legal",
              "accounting",
              "automotive",
              "appointments",
              "industrial"
            ]
          },
          "description": {
            "type": "string"
          },
          "parameters": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "string",
                    "number",
                    "boolean"
                  ]
                },
                "description": {
                  "type": "string"
                },
                "required": {
                  "type": "boolean"
                },
                "enum": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "name",
                "type",
                "description"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "name",
          "label",
          "category",
          "description",
          "parameters"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
GET /api/v1/languagesList the languages a custom niche's agents can speak

Each code is a value for agent.languages in updateCustomNiche: one code, or two for a bilingual agent that opens in the first and switches when the caller does.

Permission: dashboards:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "label"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

Client access

GET /api/v1/onboarding/access-catalogList the logins and keys builds usually need

The access catalog: for each kind of build (website, voice AI, ads, CRM, apps…), the login, key or account access to ask the client for, what they should hand over, and the safer way to share it. Use the keys in a blueprint's access list.

Permission: member. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "note",
              "login",
              "api_key"
            ]
          },
          "location": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "why": {
            "type": "string"
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "key",
          "label",
          "kind",
          "location",
          "note",
          "why",
          "services"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
GET /api/v1/clients/{client_id}/accessList what a client has been asked to hand over

Each item on the client's Access page: its name, kind, whether it is still requested or provided, when it was handed over and last opened. Never the secret itself.

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/accessAsk a client for logins, keys or account access

Adds one or more items to the client's Access page, where they hand each over into the sealed vault. Send up to 20 at once. Never ask for a password in an intake question; ask here.

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "items": {
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120,
            "description": "What to hand over, e.g. 'Domain registrar login'"
          },
          "kind": {
            "type": "string",
            "enum": [
              "login",
              "api_key",
              "note"
            ],
            "description": "login = username and password; api_key = a key or token; note = anything else, e.g. 'invite us as a manager'"
          },
          "location": {
            "description": "Where it is used, so both sides agree which account",
            "type": "string",
            "maxLength": 300
          },
          "note": {
            "description": "What the client reads when asked",
            "type": "string",
            "maxLength": 1000
          }
        },
        "required": [
          "label",
          "kind"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "result": {
      "type": "object",
      "properties": {
        "requested": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "requested"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/clients/{client_id}/access/{access_item_id}Withdraw an access request, or delete what was handed over

Withdraw an access request, or delete what was handed over

Permission: clients:manage. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/clients/{client_id}/access/{access_item_id}/revealsOpen a login or key the client handed over

Returns the stored secret. The opening is logged on the client's Access page and in the security audit log. An access token needs the owner's approval for each opening.

Permission: clients:manage. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "label": {
      "type": "string"
    },
    "kind": {
      "type": "string",
      "enum": [
        "note",
        "login",
        "api_key"
      ]
    },
    "location": {
      "type": "string",
      "nullable": true
    },
    "secret": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "secret": {
          "type": "string"
        },
        "note": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "label",
    "kind",
    "location",
    "secret"
  ],
  "additionalProperties": false
}

Onboarding design

GET /api/v1/clients/{client_id}/onboarding-contextEverything needed to design a client's intake form

The client, their deals and the services on them, their current form, what they were already asked to hand over, the design rules, the question library for their trade and services, the access catalog for those services, and a lean quick draft. Read this, then send a blueprint to buildOnboardingForm.

Permission: clients:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "client": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "businessName": {
          "type": "string"
        },
        "contactName": {
          "type": "string",
          "nullable": true
        },
        "email": {
          "type": "string",
          "nullable": true
        },
        "phone": {
          "type": "string",
          "nullable": true
        },
        "websiteUrl": {
          "type": "string",
          "nullable": true
        },
        "nicheSlug": {
          "type": "string",
          "nullable": true
        },
        "nicheLabel": {
          "type": "string",
          "nullable": true
        },
        "notes": {
          "type": "string",
          "nullable": true
        }
      },
      "required": [
        "id",
        "businessName",
        "contactName",
        "email",
        "phone",
        "websiteUrl",
        "nicheSlug",
        "nicheLabel",
        "notes"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "deals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "mode": {
            "type": "string",
            "enum": [
              "lumina",
              "self"
            ]
          },
          "status": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "mode",
          "status",
          "title",
          "services"
        ],
        "additionalProperties": false
      }
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          }
        },
        "required": [
          "slug",
          "name",
          "summary"
        ],
        "additionalProperties": false
      }
    },
    "current_form": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "asked": {
          "type": "number"
        },
        "status": {
          "type": "string"
        },
        "intakeStarted": {
          "type": "boolean"
        },
        "designed": {
          "type": "boolean"
        },
        "summary": {
          "type": "string",
          "nullable": true
        }
      },
      "required": [
        "id",
        "name",
        "asked",
        "status",
        "intakeStarted",
        "designed",
        "summary"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "current_blueprint": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "questions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "label": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "number",
                        "boolean",
                        "email",
                        "phone",
                        "text",
                        "textarea",
                        "url",
                        "select",
                        "radio",
                        "multiselect",
                        "address",
                        "hours",
                        "image_upload",
                        "document_upload",
                        "color"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "key": {
                      "type": "string"
                    },
                    "help": {
                      "type": "string"
                    },
                    "options": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "why": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "label",
                    "type",
                    "required"
                  ],
                  "additionalProperties": false
                }
              },
              "key": {
                "type": "string"
              },
              "blurb": {
                "type": "string"
              }
            },
            "required": [
              "title",
              "questions"
            ],
            "additionalProperties": false
          }
        },
        "access": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "note",
                  "login",
                  "api_key"
                ]
              },
              "key": {
                "type": "string"
              },
              "location": {
                "type": "string"
              },
              "note": {
                "type": "string"
              },
              "why": {
                "type": "string"
              }
            },
            "required": [
              "label",
              "kind"
            ],
            "additionalProperties": false
          }
        },
        "intro": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "sections",
        "access"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "existing_access": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "label",
          "kind",
          "status"
        ],
        "additionalProperties": false
      }
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "question_library": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "number",
              "boolean",
              "email",
              "phone",
              "text",
              "textarea",
              "url",
              "select",
              "radio",
              "multiselect",
              "address",
              "hours",
              "image_upload",
              "document_upload",
              "color"
            ]
          },
          "help": {
            "type": "string"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "source": {
            "type": "string",
            "enum": [
              "niche",
              "build",
              "core",
              "service"
            ]
          },
          "group": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "label",
          "type",
          "source"
        ],
        "additionalProperties": false
      }
    },
    "access_catalog": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "note",
              "login",
              "api_key"
            ]
          },
          "location": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "why": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "label",
          "kind",
          "location",
          "note",
          "why"
        ],
        "additionalProperties": false
      }
    },
    "draft_blueprint": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "questions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "label": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "number",
                        "boolean",
                        "email",
                        "phone",
                        "text",
                        "textarea",
                        "url",
                        "select",
                        "radio",
                        "multiselect",
                        "address",
                        "hours",
                        "image_upload",
                        "document_upload",
                        "color"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "key": {
                      "type": "string"
                    },
                    "help": {
                      "type": "string"
                    },
                    "options": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "why": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "label",
                    "type",
                    "required"
                  ],
                  "additionalProperties": false
                }
              },
              "key": {
                "type": "string"
              },
              "blurb": {
                "type": "string"
              }
            },
            "required": [
              "title",
              "questions"
            ],
            "additionalProperties": false
          }
        },
        "access": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "note",
                  "login",
                  "api_key"
                ]
              },
              "key": {
                "type": "string"
              },
              "location": {
                "type": "string"
              },
              "note": {
                "type": "string"
              },
              "why": {
                "type": "string"
              }
            },
            "required": [
              "label",
              "kind"
            ],
            "additionalProperties": false
          }
        },
        "intro": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "sections",
        "access"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "client",
    "deals",
    "services",
    "current_form",
    "current_blueprint",
    "existing_access",
    "rules",
    "question_library",
    "access_catalog",
    "draft_blueprint"
  ],
  "additionalProperties": false
}
GET /api/v1/onboarding/design-contextEverything needed to design a template or redesign a form

Like getClientOnboardingContext, for an agency template (pass niche_slug and service_slugs, comma separated) or an existing form (form_id).

Permission: member. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "form_id": {
      "type": "string",
      "format": "uuid"
    },
    "niche_slug": {
      "type": "string",
      "maxLength": 64
    },
    "service_slugs": {
      "description": "Comma-separated service slugs, e.g. website-build,ai-receptionist-buildout",
      "type": "string",
      "maxLength": 600
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "client": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "businessName": {
          "type": "string"
        },
        "contactName": {
          "type": "string",
          "nullable": true
        },
        "email": {
          "type": "string",
          "nullable": true
        },
        "phone": {
          "type": "string",
          "nullable": true
        },
        "websiteUrl": {
          "type": "string",
          "nullable": true
        },
        "nicheSlug": {
          "type": "string",
          "nullable": true
        },
        "nicheLabel": {
          "type": "string",
          "nullable": true
        },
        "notes": {
          "type": "string",
          "nullable": true
        }
      },
      "required": [
        "id",
        "businessName",
        "contactName",
        "email",
        "phone",
        "websiteUrl",
        "nicheSlug",
        "nicheLabel",
        "notes"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "deals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "mode": {
            "type": "string",
            "enum": [
              "lumina",
              "self"
            ]
          },
          "status": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "services": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "mode",
          "status",
          "title",
          "services"
        ],
        "additionalProperties": false
      }
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          }
        },
        "required": [
          "slug",
          "name",
          "summary"
        ],
        "additionalProperties": false
      }
    },
    "current_form": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "asked": {
          "type": "number"
        },
        "status": {
          "type": "string"
        },
        "intakeStarted": {
          "type": "boolean"
        },
        "designed": {
          "type": "boolean"
        },
        "summary": {
          "type": "string",
          "nullable": true
        }
      },
      "required": [
        "id",
        "name",
        "asked",
        "status",
        "intakeStarted",
        "designed",
        "summary"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "current_blueprint": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "questions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "label": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "number",
                        "boolean",
                        "email",
                        "phone",
                        "text",
                        "textarea",
                        "url",
                        "select",
                        "radio",
                        "multiselect",
                        "address",
                        "hours",
                        "image_upload",
                        "document_upload",
                        "color"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "key": {
                      "type": "string"
                    },
                    "help": {
                      "type": "string"
                    },
                    "options": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "why": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "label",
                    "type",
                    "required"
                  ],
                  "additionalProperties": false
                }
              },
              "key": {
                "type": "string"
              },
              "blurb": {
                "type": "string"
              }
            },
            "required": [
              "title",
              "questions"
            ],
            "additionalProperties": false
          }
        },
        "access": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "note",
                  "login",
                  "api_key"
                ]
              },
              "key": {
                "type": "string"
              },
              "location": {
                "type": "string"
              },
              "note": {
                "type": "string"
              },
              "why": {
                "type": "string"
              }
            },
            "required": [
              "label",
              "kind"
            ],
            "additionalProperties": false
          }
        },
        "intro": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "sections",
        "access"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "existing_access": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "label",
          "kind",
          "status"
        ],
        "additionalProperties": false
      }
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "question_library": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "number",
              "boolean",
              "email",
              "phone",
              "text",
              "textarea",
              "url",
              "select",
              "radio",
              "multiselect",
              "address",
              "hours",
              "image_upload",
              "document_upload",
              "color"
            ]
          },
          "help": {
            "type": "string"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "source": {
            "type": "string",
            "enum": [
              "niche",
              "build",
              "core",
              "service"
            ]
          },
          "group": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "label",
          "type",
          "source"
        ],
        "additionalProperties": false
      }
    },
    "access_catalog": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "note",
              "login",
              "api_key"
            ]
          },
          "location": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "why": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "label",
          "kind",
          "location",
          "note",
          "why"
        ],
        "additionalProperties": false
      }
    },
    "draft_blueprint": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "questions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "label": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "number",
                        "boolean",
                        "email",
                        "phone",
                        "text",
                        "textarea",
                        "url",
                        "select",
                        "radio",
                        "multiselect",
                        "address",
                        "hours",
                        "image_upload",
                        "document_upload",
                        "color"
                      ]
                    },
                    "required": {
                      "type": "boolean"
                    },
                    "key": {
                      "type": "string"
                    },
                    "help": {
                      "type": "string"
                    },
                    "options": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "why": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "label",
                    "type",
                    "required"
                  ],
                  "additionalProperties": false
                }
              },
              "key": {
                "type": "string"
              },
              "blurb": {
                "type": "string"
              }
            },
            "required": [
              "title",
              "questions"
            ],
            "additionalProperties": false
          }
        },
        "access": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "note",
                  "login",
                  "api_key"
                ]
              },
              "key": {
                "type": "string"
              },
              "location": {
                "type": "string"
              },
              "note": {
                "type": "string"
              },
              "why": {
                "type": "string"
              }
            },
            "required": [
              "label",
              "kind"
            ],
            "additionalProperties": false
          }
        },
        "intro": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "sections",
        "access"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "client",
    "deals",
    "services",
    "current_form",
    "current_blueprint",
    "existing_access",
    "rules",
    "question_library",
    "access_catalog",
    "draft_blueprint"
  ],
  "additionalProperties": false
}
POST /api/v1/onboarding/blueprintsBuild an intake form from a blueprint, in one call

Writes a whole form: sections, questions, intro, and the logins and keys to ask for. Target exactly one of client_id (that client's form, made if they have none), form_id (rebuild an existing form), or template: true (a new agency template). Standard questions the blueprint leaves out stay on the form switched off, under Not asked. Answers already given to questions that stay are kept. On a client's form, each access item is added to their Access page (skipped if one with the same name is already there). On a template, the access list is saved and filed for each client the template is applied to. Rules: Ask only what this build needs. A short, specific form gets finished; a long generic one stalls the build. Never ask what the agency already knows (the client record has the business name, contact, email, phone and website). Reuse a library key when a question is a standard one, so the answer lands where the build brief expects it. Write new questions for anything specific to this business. Make a question required only when the build cannot start without it. Prefer choices (select, radio, multiselect, boolean) over free text when the answers are predictable. Group questions into a few plain sections in the order a client can answer them. Logins, API keys and account access are never form questions. Put them in access, so they go to the client's sealed Access vault. For access, prefer the safer route the catalog describes (invite us as a manager, a restricted key) over sharing a password. If the client's Access page already has an item, leave it out or reuse its exact name; never ask twice under a new name. Write in the agency's voice, plainly, with an example in help where a question could be misread.

Permission: member. Success: 201. Maximum body: 200000 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "client_id": {
      "type": "string",
      "format": "uuid"
    },
    "form_id": {
      "type": "string",
      "format": "uuid"
    },
    "template": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "blueprint": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120,
          "description": "Form name, e.g. 'Smith Roofing website onboarding'"
        },
        "intro": {
          "description": "What the client reads at the top, written as the agency",
          "type": "string",
          "maxLength": 2000
        },
        "summary": {
          "description": "What is being built and what this form is for, for the agency. Not shown to the client",
          "type": "string",
          "maxLength": 4000
        },
        "sections": {
          "minItems": 1,
          "maxItems": 12,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{1,63}$"
              },
              "title": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "blurb": {
                "type": "string",
                "maxLength": 240
              },
              "questions": {
                "minItems": 1,
                "maxItems": 40,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "key": {
                      "description": "Reuse a library key (from the question library) when the question is a standard one, so the answer lands where the build brief expects it. Leave it out for a new question.",
                      "type": "string",
                      "pattern": "^[a-z][a-z0-9_]{1,63}$"
                    },
                    "label": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200,
                      "description": "The question as the client reads it"
                    },
                    "help": {
                      "description": "One line under the question: an example or why it matters",
                      "type": "string",
                      "maxLength": 500
                    },
                    "type": {
                      "default": "text",
                      "type": "string",
                      "enum": [
                        "text",
                        "textarea",
                        "email",
                        "url",
                        "phone",
                        "number",
                        "select",
                        "radio",
                        "multiselect",
                        "boolean",
                        "address",
                        "hours",
                        "image_upload",
                        "document_upload",
                        "color"
                      ]
                    },
                    "required": {
                      "default": false,
                      "type": "boolean"
                    },
                    "options": {
                      "description": "Choices, for select, radio and multiselect only",
                      "maxItems": 30,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 120
                      }
                    },
                    "why": {
                      "description": "Why this build needs it. Agency only",
                      "type": "string",
                      "maxLength": 300
                    }
                  },
                  "required": [
                    "label"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "title",
              "questions"
            ],
            "additionalProperties": false
          }
        },
        "access": {
          "default": [],
          "maxItems": 20,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "description": "An access catalog key, e.g. domain_registrar. Leave it out for a custom ask",
                "type": "string",
                "maxLength": 64
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120,
                "description": "What to hand over, e.g. 'Domain registrar login'"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "login",
                  "api_key",
                  "note"
                ],
                "description": "login = username + password; api_key = a key or token; note = anything else, e.g. 'invite us as a manager'"
              },
              "location": {
                "description": "Where it is used, so both sides agree which account",
                "type": "string",
                "maxLength": 300
              },
              "note": {
                "description": "What the client reads: what to share and the safer way to share it",
                "type": "string",
                "maxLength": 1000
              },
              "why": {
                "description": "Why the build needs it. Agency only",
                "type": "string",
                "maxLength": 300
              }
            },
            "required": [
              "label",
              "kind"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "name",
        "sections"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "blueprint"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "result": {
      "type": "object",
      "properties": {
        "form_id": {
          "type": "string"
        },
        "client_id": {
          "type": "string",
          "nullable": true
        },
        "edit_path": {
          "type": "string"
        },
        "questions_asked": {
          "type": "number"
        },
        "questions_switched_off": {
          "type": "number"
        },
        "access_requested": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "access_skipped": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "form_id",
        "client_id",
        "edit_path",
        "questions_asked",
        "questions_switched_off",
        "access_requested",
        "access_skipped"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Scope Calculator

GET /api/v1/scope-sessionsList Scope Calculator estimates

The agency's estimates, most recently updated first, each with its client, status, and the priced estimate once there is one (dollars only). Archived estimates are left out unless include_archived is true.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "include_archived": {
      "description": "Send true to include archived estimates.",
      "type": "string",
      "enum": [
        "true",
        "false"
      ]
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "client_id": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "billed_with_credits": {
            "type": "boolean"
          },
          "estimate": {
            "type": "object",
            "properties": {
              "setup": {
                "type": "object",
                "properties": {
                  "likely": {
                    "type": "number"
                  },
                  "low": {
                    "type": "number"
                  },
                  "high": {
                    "type": "number"
                  }
                },
                "required": [
                  "likely",
                  "low",
                  "high"
                ],
                "additionalProperties": false
              },
              "monthly": {
                "type": "object",
                "properties": {
                  "likely": {
                    "type": "number"
                  },
                  "low": {
                    "type": "number"
                  },
                  "high": {
                    "type": "number"
                  }
                },
                "required": [
                  "likely",
                  "low",
                  "high"
                ],
                "additionalProperties": false
              },
              "usage": {
                "type": "object",
                "properties": {
                  "voicePerMinute": {
                    "type": "number"
                  }
                },
                "required": [
                  "voicePerMinute"
                ],
                "additionalProperties": false,
                "nullable": true
              },
              "rebill": {
                "type": "object",
                "properties": {
                  "platform": {
                    "type": "object",
                    "properties": {
                      "likely": {
                        "type": "number"
                      },
                      "low": {
                        "type": "number"
                      },
                      "high": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "likely",
                      "low",
                      "high"
                    ],
                    "additionalProperties": false
                  },
                  "usage": {
                    "type": "object",
                    "properties": {
                      "likely": {
                        "type": "number"
                      },
                      "low": {
                        "type": "number"
                      },
                      "high": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "likely",
                      "low",
                      "high"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "platform",
                  "usage"
                ],
                "additionalProperties": false,
                "nullable": true
              },
              "lines": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "label": {
                      "type": "string"
                    },
                    "slug": {
                      "type": "string",
                      "nullable": true
                    },
                    "setup": {
                      "type": "object",
                      "properties": {
                        "likely": {
                          "type": "number"
                        },
                        "low": {
                          "type": "number"
                        },
                        "high": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "likely",
                        "low",
                        "high"
                      ],
                      "additionalProperties": false,
                      "nullable": true
                    },
                    "monthly": {
                      "type": "object",
                      "properties": {
                        "likely": {
                          "type": "number"
                        },
                        "low": {
                          "type": "number"
                        },
                        "high": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "likely",
                        "low",
                        "high"
                      ],
                      "additionalProperties": false,
                      "nullable": true
                    },
                    "kind": {
                      "type": "string",
                      "enum": [
                        "core",
                        "addon",
                        "included"
                      ]
                    },
                    "note": {
                      "type": "string"
                    },
                    "standalone": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "label",
                    "slug",
                    "setup",
                    "monthly"
                  ],
                  "additionalProperties": false
                }
              },
              "assumptions": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "risks": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "priceMovers": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "confidence": {
                "type": "string",
                "enum": [
                  "medium",
                  "high",
                  "low"
                ]
              }
            },
            "required": [
              "setup",
              "monthly",
              "usage",
              "rebill",
              "lines",
              "assumptions",
              "risks",
              "priceMovers",
              "confidence"
            ],
            "additionalProperties": false,
            "nullable": true
          },
          "estimate_version": {
            "type": "number"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "client_id",
          "title",
          "status",
          "billed_with_credits",
          "estimate",
          "estimate_version",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    }
  },
  "required": [
    "items",
    "total",
    "limit",
    "offset"
  ],
  "additionalProperties": false
}
GET /api/v1/scope-sessions/{scope_session_id}Get one Scope Calculator estimate with its conversation

The estimate, the user and assistant messages of its conversation (text only), and the material attached to it. Document text is not included.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    },
    "id": {
      "type": "string"
    },
    "client_id": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "billed_with_credits": {
      "type": "boolean"
    },
    "estimate": {
      "type": "object",
      "properties": {
        "setup": {
          "type": "object",
          "properties": {
            "likely": {
              "type": "number"
            },
            "low": {
              "type": "number"
            },
            "high": {
              "type": "number"
            }
          },
          "required": [
            "likely",
            "low",
            "high"
          ],
          "additionalProperties": false
        },
        "monthly": {
          "type": "object",
          "properties": {
            "likely": {
              "type": "number"
            },
            "low": {
              "type": "number"
            },
            "high": {
              "type": "number"
            }
          },
          "required": [
            "likely",
            "low",
            "high"
          ],
          "additionalProperties": false
        },
        "usage": {
          "type": "object",
          "properties": {
            "voicePerMinute": {
              "type": "number"
            }
          },
          "required": [
            "voicePerMinute"
          ],
          "additionalProperties": false,
          "nullable": true
        },
        "rebill": {
          "type": "object",
          "properties": {
            "platform": {
              "type": "object",
              "properties": {
                "likely": {
                  "type": "number"
                },
                "low": {
                  "type": "number"
                },
                "high": {
                  "type": "number"
                }
              },
              "required": [
                "likely",
                "low",
                "high"
              ],
              "additionalProperties": false
            },
            "usage": {
              "type": "object",
              "properties": {
                "likely": {
                  "type": "number"
                },
                "low": {
                  "type": "number"
                },
                "high": {
                  "type": "number"
                }
              },
              "required": [
                "likely",
                "low",
                "high"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "platform",
            "usage"
          ],
          "additionalProperties": false,
          "nullable": true
        },
        "lines": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "slug": {
                "type": "string",
                "nullable": true
              },
              "setup": {
                "type": "object",
                "properties": {
                  "likely": {
                    "type": "number"
                  },
                  "low": {
                    "type": "number"
                  },
                  "high": {
                    "type": "number"
                  }
                },
                "required": [
                  "likely",
                  "low",
                  "high"
                ],
                "additionalProperties": false,
                "nullable": true
              },
              "monthly": {
                "type": "object",
                "properties": {
                  "likely": {
                    "type": "number"
                  },
                  "low": {
                    "type": "number"
                  },
                  "high": {
                    "type": "number"
                  }
                },
                "required": [
                  "likely",
                  "low",
                  "high"
                ],
                "additionalProperties": false,
                "nullable": true
              },
              "kind": {
                "type": "string",
                "enum": [
                  "core",
                  "addon",
                  "included"
                ]
              },
              "note": {
                "type": "string"
              },
              "standalone": {
                "type": "number"
              }
            },
            "required": [
              "label",
              "slug",
              "setup",
              "monthly"
            ],
            "additionalProperties": false
          }
        },
        "assumptions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "risks": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "priceMovers": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "confidence": {
          "type": "string",
          "enum": [
            "medium",
            "high",
            "low"
          ]
        }
      },
      "required": [
        "setup",
        "monthly",
        "usage",
        "rebill",
        "lines",
        "assumptions",
        "risks",
        "priceMovers",
        "confidence"
      ],
      "additionalProperties": false,
      "nullable": true
    },
    "estimate_version": {
      "type": "number"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    }
  },
  "required": [
    "messages",
    "attachments",
    "id",
    "client_id",
    "title",
    "status",
    "billed_with_credits",
    "estimate",
    "estimate_version",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
POST /api/v1/scope-sessionsStart a Scope Calculator estimate

Starts a new estimate, optionally linked to a client. It uses one of the month's free estimates, or once those are used, the estimate spends Lumina AI credits as the conversation runs. Chatting with the calculator happens in the dashboard.

Permission: fulfillment:view. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "client_id": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "result": {
      "type": "object",
      "properties": {
        "sessionId": {
          "type": "string"
        }
      },
      "required": [
        "sessionId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
DELETE /api/v1/scope-sessions/{scope_session_id}Archive a Scope Calculator estimate

The estimate leaves the list and becomes read-only. Nothing is deleted, but it cannot be reopened.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
PUT /api/v1/scope-sessions/{scope_session_id}/clientLink an estimate to a client, or unlink it

Send a client_id to link one of your clients, or null to clear the link.

Permission: fulfillment:view. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "client_id": {
      "nullable": true,
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "client_id"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/scope-sessions/{scope_session_id}/transcriptsAdd a call transcript to an estimate

Pasted transcript text the calculator scopes from. The same length limits apply as in the dashboard.

Permission: fulfillment:view. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 210000
    }
  },
  "required": [
    "text"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}
POST /api/v1/scope-sessions/{scope_session_id}/fathom-linksAdd a Fathom call recording link to an estimate

Saved as a link only. The calculator reads the recording the first time it needs it.

Permission: fulfillment:view. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "nullable": true
    },
    "result": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}

Developers

GET /api/v1/access-tokensList the agency's access tokens

Label, scopes, the visible prefix, who created each token, when it expires, when it was last used, and whether it was revoked. Never the token itself.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

Query parameter schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}
POST /api/v1/access-tokensCreate an access token

Returns the token once, in this response; it cannot be read again. api:write lets the holder make changes as you. A token calling this can only grant scopes it holds and an expiry no later than its own.

Permission: owner. Success: 201. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "scopes": {
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "api:read",
          "api:write",
          "blogs:read",
          "blogs:write",
          "blogs:generate"
        ]
      }
    },
    "expires_in_days": {
      "default": 90,
      "type": "integer",
      "minimum": 1,
      "maximum": 365
    }
  },
  "required": [
    "label",
    "scopes"
  ],
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "record": {
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "token",
    "record"
  ],
  "additionalProperties": false
}
DELETE /api/v1/access-tokens/{token_id}Revoke an access token

The token stops working at once and cannot be restored. Revoking the token making this request ends its own access.

Permission: owner. Success: 200. Maximum body: 1048576 bytes.

JSON request schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response data schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "result": {
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "message",
    "result"
  ],
  "additionalProperties": false
}