A valid request URL is required to generate request examples{
"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
}
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}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.
A valid request URL is required to generate request examples{
"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
}
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
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.
- Token URL
- /api/v1/api-keys
Query Parameters
Evaluate per-list contact readiness (scrub-clean + PEWC) for a marketing launch over this list.