> ## Documentation Index > Fetch the complete documentation index at: https://docs.flowyte.com/llms.txt > Use this file to discover all available pages before exploring further. # Marketing onboarding state + readiness checklist > Returns your organization's marketing-onboarding state (seller identity + National-DNC SAN + status) and the GREEN/YELLOW/RED readiness checklist that gates the marketing un-gate. Org-level items (scrub subscription active, PEWC disclosure approved + stored, seller identity set) are always present; pass ?listId= to also get the per-list contact readiness (contactsNotScrubbed, contactsWithoutPewc) and the EXACT launchBlockedReason a marketing campaign over that list would hit — the same pure gate the launch endpoint runs. ready is true ONLY when a list was evaluated and its launchBlockedReason is empty. This is READ-ONLY state; it never activates anything. ## OpenAPI ````yaml /openapi.yaml get /outbound/marketing/onboarding openapi: 3.1.0 info: title: Flowyte V2 Control-Plane REST API version: 1.0.0 description: >- The single REST API for the Flowyte platform (base path `/api/v1`). Authenticate every request with a secret API key — `Authorization: Bearer flowyte_sk_…` — and each operation lists the scope the key must hold. Successful responses use the `ApiResponse` envelope; list responses use cursor-based `PaginatedResponse`. Errors are RFC 9457 problem+json. Streaming endpoints return Server-Sent Events (`event:\ndata:\n\n`, terminating with `event: done`). contact: name: Flowyte Platform license: name: Proprietary servers: - url: /api/v1 description: Flowyte control-plane (versioned URI; additive in v1). security: - apiKey: [] tags: - name: Agents description: The single user-facing entity. - name: Support description: In-app "Get help" form → support inbox email. - name: Skills description: > Agent capabilities / tools. A skill is ONE atomic action — typically a single API call the agent makes in one step (look up an order, create a record, send a message, transfer the call). Use a skill when the task is a single step. When a task needs several details gathered across turns BEFORE acting, build a Playbook (which gathers the inputs and then calls skills) — see the Playbooks tag. - name: Integrations description: Native OAuth integrations. - name: Knowledge description: RAG knowledge sources & preview. - name: Playbooks description: > Multi-turn conversation scripts — a node graph (gather → confirm → branch) the agent follows to collect several inputs IN ORDER across turns before acting. Build a playbook when a single skill call isn't enough because the agent must gather MANY details first, or run a SEQUENCE of skills, before it can finish (e.g. take a full service request: gather the problem, address, and time, confirm, THEN file it; qualify a lead; a multi-step intake). A playbook does NOT call an integration itself — it owns the conversation and holds the state across turns; the actual action is performed by the SKILL(s) it gathers the inputs for. So a playbook ORCHESTRATES skills. Rule of thumb — one API call → a Skill; "gather N things in order, then submit" → a Playbook that drives the conversation and calls the skill(s) at the end. - name: Variables description: > The agent-wide interaction-variable registry — DERIVED at read time from the agent's playbooks and skills (collect slots, skill output bindings, {var} placeholders) and merged with a thin annotation overlay (notes, declared type hints, manual declarations). Read-only observation, NEVER a gate: it never validates a reference and never affects authoring, publish, or runtime behaviour. - name: Guardrails description: Deterministic guardrail policies & caller verification. - name: Numbers description: Phone numbers / DIDs. - name: SMS description: > SMS Hub — A2P 10DLC self-serve registration (brand + campaign), the free AI compliance review, per-number SMS enablement, and the consent/opt-out surface (suppressions, contacts, TCPA proof export). Texting is US-only; a number must be SMS-enabled and the org's 10DLC registration active before it can send. - name: Test description: Test, simulate, talk-token, probe. - name: Observe description: Post-call analytics, conversations, receipts, transcripts. - name: Billing description: Plans, wallet, usage, fixed phrases. - name: Voices description: Voice catalog. - name: ApiKeys description: Developer / API keys. - name: Webhooks description: Webhook endpoints & deliveries. - name: Records description: > Caller Context Store — pre-synced external records the agent greets a caller from, plus the learned object-type field registry. Fed by the Zapier app's Create/Update Record action and directly by this REST API; read at call time by the context_lookup skill (a sub-100ms local lookup, no Zapier round-trip). - name: AuditLogs description: API/key activity logs. - name: Chat description: Chat channel — sessions, messages, OpenAI-compatible, widget. - name: PublishableKeys description: Browser-safe, one-agent publishable keys. - name: Widget description: Embed widget config + snippet. - name: Uploads description: Multipart file uploads backing file_id params - name: Meta description: Platform metadata (language/SKU/tier capabilities). - name: Outbound description: > Outbound voice — contact lists (import + scrub) and campaigns (create, launch, pause/resume/cancel). Launch schedules one call attempt per valid contact; a background worker dials them. This release dials informational campaigns only. - name: Team description: > Team Members — the general "invite a teammate" surface (roster, the platform invitations, role changes/removals, and the domain-discovery join-request inbox). Distinct from the Flowyte Phone SEAT surface: a team invite mints NO softphone seat. Reads → team:read; mutations → team:write (owner/admin; staff is role-gated out). Owner-only guards protect owner grants/edits and the org's last owner; no self-role-change or self-removal. - name: Onboarding description: > Pre-org domain discovery — the signup-flow seam a just-signed-in user hits BEFORE they have a workspace, to learn "your coworkers may already be here" and ask to join. Engine-root, authenticated by a the platform session JWT that may have no active org; tenancy is derived SERVER-SIDE from the caller's verified email (anti-enumeration), never from input. - name: OAuth2 description: > Flowyte's minimal OAuth2 authorization server. The Flowyte Zapier app is the first registered client. The authorization-code grant (confidential client, optional PKCE) issues org-scoped SERVICE tokens (flowyte_oat_…) that ride the SAME scope matrix as an sk key. The public authorize/token/revoke endpoints are served at the ORIGIN ROOT (NOT under /api/v1 — see each path's `servers` override); consent + disconnect are /api/v1. paths: /outbound/marketing/onboarding: get: tags: - Outbound summary: Marketing onboarding state + readiness checklist description: > Returns your organization's marketing-onboarding state (seller identity + National-DNC SAN + status) and the GREEN/YELLOW/RED readiness checklist that gates the marketing un-gate. Org-level items (scrub subscription active, PEWC disclosure approved + stored, seller identity set) are always present; pass ?listId= to also get the per-list contact readiness (contactsNotScrubbed, contactsWithoutPewc) and the EXACT launchBlockedReason a marketing campaign over that list would hit — the same pure gate the launch endpoint runs. ready is true ONLY when a list was evaluated and its launchBlockedReason is empty. This is READ-ONLY state; it never activates anything. operationId: getMarketingOnboarding parameters: - name: listId in: query required: false description: >- Evaluate per-list contact readiness (scrub-clean + PEWC) for a marketing launch over this list. example: obl_7a3f21c9e5b04d68 schema: type: string responses: '200': description: The onboarding state + readiness checklist. content: application/json: schema: $ref: '#/components/schemas/ApiResponse_MarketingOnboarding' example: success: true data: subscription: legalName: Acme Home Services LLC sellerName: Acme Home Services ein: 84-1234567 posture: tenant_seller subscribedAreaCodes: - '415' - '628' provider: direct reviewStatus: green pewcDisclosureApproved: false status: submitted submittedAt: '2026-07-13T15:00:00.000Z' createdAt: '2026-07-13T14:00:00.000Z' updatedAt: '2026-07-13T15:00:00.000Z' readiness: scrubSubscriptionActive: false pewcDisclosureApproved: false pewcDisclosureStored: true sellerIdentitySet: true listEvaluated: true contactsNotScrubbed: 12 contactsWithoutPewc: 40 launchBlockedReason: scrub subscription not active ready: false '401': $ref: '#/components/responses/Unauthorized' security: - apiKey: - outbound:read components: schemas: ApiResponse_MarketingOnboarding: allOf: - $ref: '#/components/schemas/ApiResponseBase' - type: object required: - data properties: data: $ref: '#/components/schemas/MarketingOnboarding' ApiResponseBase: type: object required: - success properties: success: type: boolean message: type: string errors: type: array items: type: object required: - field - message properties: field: type: string message: type: string MarketingOnboarding: type: object properties: subscription: $ref: '#/components/schemas/DNCScrubSubscription' readiness: $ref: '#/components/schemas/MarketingReadiness' ProblemDetails: description: RFC 9457 problem+json. type: object properties: type: type: string format: uri default: about:blank title: type: string status: type: integer detail: type: string instance: type: string code: type: string errors: type: array items: type: object properties: field: type: string message: type: string DNCScrubSubscription: type: object description: > An org's DNC-scrub / SAN subscription + marketing-onboarding state (one row per org). Carries the seller identity, the National-DNC SAN + per-area-code entitlement, the green/yellow/red AI pre-review color, and the live status (draft|submitted|active|failed). The marketing launch is hard-gated on status='active'. The credential reference is never surfaced. properties: legalName: type: string description: The seller legal entity. sellerName: type: string description: The consumer-facing seller name (PEWC element c). ein: type: string sellerAddress: type: string sellerPhone: type: string posture: type: string description: >- tenant_seller (default) | flowyte_caller — the liability posture as DATA. san: type: string description: National-DNC Subscription Account Number (tenant-held). subscribedAreaCodes: type: array items: type: string stateRegistrations: type: object additionalProperties: type: string provider: type: string description: direct (donotcall.gov) | vendor. certificationAttestedAt: type: - string - 'null' lastScrubAt: type: - string - 'null' reviewStatus: type: string description: '''''|green|yellow|red' pewcDisclosureApproved: type: boolean description: A6 counsel-approval gate (never self-serve). pewcDisclosureText: type: string description: the org's stored PEWC opt-in copy status: type: string description: draft|submitted|active|failed providerStatus: type: string lastError: type: string submittedAt: type: - string - 'null' createdAt: type: string updatedAt: type: string MarketingReadiness: type: object description: > The GREEN/YELLOW/RED marketing-launch readiness checklist. Org-level items are always present; the per-list items + launchBlockedReason are populated only when a listId was evaluated (listEvaluated). ready is true ONLY when a list was evaluated and its launchBlockedReason is empty (you cannot launch nothing). properties: scrubSubscriptionActive: type: boolean pewcDisclosureApproved: type: boolean pewcDisclosureStored: type: boolean sellerIdentitySet: type: boolean listEvaluated: type: boolean contactsNotScrubbed: type: integer contactsWithoutPewc: type: integer launchBlockedReason: type: string description: >- The exact reason a marketing launch over the supplied list would be refused ("" = ready). ready: type: boolean responses: Unauthorized: description: Missing or invalid API key. headers: WWW-Authenticate: schema: type: string content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' securitySchemes: apiKey: type: oauth2 description: > Flowyte secret API key (`Authorization: Bearer flowyte_sk_live_…`). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's `apiKey` requirement are the scopes that key must hold. The `tokenUrl` is nominal: keys are minted in the dashboard. flows: clientCredentials: tokenUrl: /api/v1/api-keys scopes: agents:read: Read agents. agents:write: Create/update/delete agents, publish, rollback. knowledge:read: Read knowledge sources & preview. knowledge:write: Add/remove knowledge sources, uploads. skills:read: Read skills & skill-types. skills:write: Create/update/delete skills. playbooks:read: Read playbooks & graphs. playbooks:write: Create/update/delete playbooks & graphs. guardrails:read: Read guardrail policies & caller-verification. guardrails:write: Update guardrail policies & caller-verification. numbers:read: Read phone numbers / search availability. numbers:write: Purchase / assign / release numbers. sms:read: Read the org's SMS (10DLC) registration status and numbers. sms:write: Save/submit the 10DLC registration and toggle numbers for SMS. outbound:read: Read outbound contact lists and campaigns. outbound:write: >- Create/import contact lists, create/launch/pause/resume/cancel outbound campaigns, and enqueue single outbound calls. integrations:read: Read connected native integrations (status only — never tokens). integrations:write: Discover schemas, set data scoping, and disconnect a connection. integrations:connect: >- Connect a data source (submit credentials / begin OAuth) — a SEPARATE, higher-privilege scope because connecting INGESTS credentials and opens a new egress path; a discover/scope/author key need not carry it. records:read: >- Read the pre-synced Caller Context Store records and object-type field registry. records:write: >- Upsert / delete / bulk-import / purge caller-context records and edit type metadata. calls:read: Read conversations, receipts, transcripts, analytics. analytics:read: >- Read the Observe history list, per-agent analytics (the answer-rate summary), the raw knowledge-gap list, and the metric catalog + per-metric queries + metric drill-downs. analytics:write: >- Curate knowledge gaps (dismiss / mark in-progress). [M4 — reserved] dashboards:read: List and read saved Observe reporting dashboards. dashboards:write: >- Create, update (full-document replace), and delete Observe reporting dashboards. reports:read: List and read Observe scheduled reports (report schedules). reports:write: >- Create, update, and delete Observe scheduled reports (a delete stops a recurring digest). billing:read: Read plans, wallet, usage. audit:read: Read API/key activity logs. webhooks:write: Manage webhook endpoints. keys:write: Manage secret API keys. chat:read: Read chat sessions & messages. chat:write: Create chat sessions & send messages (server-side). widgets:read: Read widget config & embed snippet. widgets:write: Update widget config. pubkeys:read: Read publishable keys. pubkeys:write: Manage publishable keys. phone:read: >- Read Flowyte Phone config — settings, ring targets/queues + rosters, contacts, block-list, own presence. phone:write: >- Update Flowyte Phone config — settings, ring targets/queues + members, contacts, block-list. presence:write: Set your own softphone presence (available/away/dnd/…). team:read: Read the team — softphone seats and the team presence roster. team:write: >- Manage softphone seats — invite, update, and deactivate team members. escalation_destinations:read: Read external-agent (AI Harness) escalation destinations. escalation_destinations:write: >- Create, update, delete, and rotate the signing secret of escalation destinations. escalation_policies:read: Read an agent's escalation routing policy. [ — reserved] escalation_policies:write: Update an agent's escalation routing policy. [ — reserved] escalations:read: >- Read escalation sessions and their message history (connector). [ — reserved] escalations:claim: >- Claim an escalation session and extend its lease (connector). [ — reserved] escalations:respond: >- Post messages into a claimed escalation session (connector). [ — reserved] escalations:resolve: >- Resolve, return, or request human takeover of an escalation (connector). [ — reserved] escalations:initiate: >- Start a NEW outbound SMS conversation with a customer (connector). Deliberately separate from escalations:respond — the other scopes work a conversation the platform handed over; this one texts a person who never contacted you on that thread. Also requires the org to be enabled for harness-initiated conversations. ````