Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"subscription": {
"sellerName": "Acme Home Services",
"status": "submitted",
"pewcDisclosureApproved": false,
"pewcDisclosureText": "By providing your number and checking this box, you agree to receive marketing calls...",
"updatedAt": "2026-07-13T15:30:00.000Z"
},
"readiness": {
"scrubSubscriptionActive": false,
"pewcDisclosureApproved": false,
"pewcDisclosureStored": true,
"sellerIdentitySet": true,
"listEvaluated": false,
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Outbound
Store the org's PEWC opt-in disclosure copy
Store the org’s consumer-facing PEWC opt-in disclosure copy (rendered by the hosted opt-in form). STORING the copy is self-serve; APPROVING it is NOT — this NEVER flips pewcDisclosureApproved (the four 47 CFR 64.1200(f)(9) elements are a legal artifact counsel / an admin must finalize, A6). The org must have started onboarding (a submitted identity) first.
POST
/
outbound
/
marketing
/
onboarding
/
disclosure
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"subscription": {
"sellerName": "Acme Home Services",
"status": "submitted",
"pewcDisclosureApproved": false,
"pewcDisclosureText": "By providing your number and checking this box, you agree to receive marketing calls...",
"updatedAt": "2026-07-13T15:30:00.000Z"
},
"readiness": {
"scrubSubscriptionActive": false,
"pewcDisclosureApproved": false,
"pewcDisclosureStored": true,
"sellerIdentitySet": true,
"listEvaluated": false,
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"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.
FlowClient Credentials
- Token URL
- /api/v1/api-keys
Scopes1
outbound:write
Create/import contact lists, create/launch/pause/resume/cancel outbound campaigns, and enqueue single outbound calls.
Body
application/json
the org's consumer-facing PEWC opt-in copy (stored, NOT approved).