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": "cancelled",
"dialingMode": "predictive",
"messageCategory": "informational",
"audienceType": "consumer",
"createdAt": "2026-07-13T15:04:00.000Z",
"updatedAt": "2026-07-13T17:30:00.000Z"
}
}{
"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
Cancel a campaign
Cancels the campaign and its not-yet-dialed attempts; in-flight calls finish normally. This is terminal — unlike pauseOutboundCampaign, a cancelled campaign cannot be resumed.
POST
/
outbound
/
campaigns
/
{id}
/
cancel
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": "cancelled",
"dialingMode": "predictive",
"messageCategory": "informational",
"audienceType": "consumer",
"createdAt": "2026-07-13T15:04:00.000Z",
"updatedAt": "2026-07-13T17:30:00.000Z"
}
}{
"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 campaign id to cancel.