Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

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.

Body

application/json
name
string
required
agentId
string
required
listId
string
required
callerNumberId
string
required
messageCategory
enum<string>
default:informational
Available options:
informational,
marketing
audienceType
enum<string>
default:consumer
Available options:
consumer,
business
schedule
object

Optional dialing window. Common keys: timezone (IANA, e.g. "America/New_York"), dailyStart / dailyEnd ("HH:MM" local, honoring callee quiet-hours), daysOfWeek (array of 0–6, Sun=0). Omit to use platform defaults.

pacing
object

Optional dial-rate control. Common keys: maxConcurrent (simultaneous live calls), callsPerMinute. Omit for conservative defaults.

retryPolicy
object

Optional re-attempt rules for no-answer/busy/voicemail. Common keys: maxAttempts, retryAfterMinutes, retryOn (array of outcomes, e.g. ["no_answer","busy"]).

voicemailPolicy
object

Optional answering-machine handling. Common keys: action ("hangup" | "leave_message"), messageText (used when action is leave_message).

greetingOverride
string
playbookId
string
goals
string
spendCapCents
integer

Optional spend cap for the campaign

Response

Created draft campaign.

success
boolean
required
data
object
required
message
string
errors
object[]