Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "obc_2d8e14f7a9c3b0e6",
"organizationId": "org_2Yh1kQ",
"name": "Spring service reminders",
"agentId": "agt_4f9c2b7e10a24d51",
"listId": "obl_7a3f21c9e5b04d68",
"callerNumberId": "pn_6a2f9c31e07b4d58",
"status": "running",
"dialingMode": "predictive",
"messageCategory": "informational",
"audienceType": "consumer",
"consentAttestedAt": "2026-07-13T15:10:00.000Z",
"launchedAt": "2026-07-13T15:10:00.000Z",
"createdAt": "2026-07-13T15:04:00.000Z",
"updatedAt": "2026-07-13T15:10:00.000Z",
"counts": {
"total": 498,
"scheduled": 498,
"queued": 0,
"dialing": 0,
"inProgress": 0,
"completed": 0,
"noAnswer": 0,
"voicemail": 0,
"failed": 0,
"suppressed": 0,
"cancelled": 0
}
}
}{
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Outbound
Launch a campaign (begins dialing)
Launch a draft campaign: validates that it is an informational campaign (a 422 is returned otherwise — marketing campaigns are not yet launchable), records the required consent attestation, schedules one call attempt per valid contact, and sets the campaign running. Requires consentAttested true.
POST
/
outbound
/
campaigns
/
{id}
/
launch
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "obc_2d8e14f7a9c3b0e6",
"organizationId": "org_2Yh1kQ",
"name": "Spring service reminders",
"agentId": "agt_4f9c2b7e10a24d51",
"listId": "obl_7a3f21c9e5b04d68",
"callerNumberId": "pn_6a2f9c31e07b4d58",
"status": "running",
"dialingMode": "predictive",
"messageCategory": "informational",
"audienceType": "consumer",
"consentAttestedAt": "2026-07-13T15:10:00.000Z",
"launchedAt": "2026-07-13T15:10:00.000Z",
"createdAt": "2026-07-13T15:04:00.000Z",
"updatedAt": "2026-07-13T15:10:00.000Z",
"counts": {
"total": 498,
"scheduled": 498,
"queued": 0,
"dialing": 0,
"inProgress": 0,
"completed": 0,
"noAnswer": 0,
"voicemail": 0,
"failed": 0,
"suppressed": 0,
"cancelled": 0
}
}
}{
"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>"
}
]
}{
"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.
Path Parameters
The draft campaign id to launch.
Body
application/json
Must be true — attests you have a lawful basis to contact every recipient.