Create an outbound campaign (draft)
Create a draft campaign over a contact list. The agent, caller-ID number, and list must all belong to your organization. Created in status draft; call launch to begin dialing. This release dials message_category informational only. Use this (with launchOutboundCampaign) for paced bulk dialing over a contact list. For a single ad-hoc dial, use enqueueOutboundCall (POST /outbound/calls) instead.
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.
Body
informational, marketing consumer, business 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.
Optional dial-rate control. Common keys: maxConcurrent (simultaneous live calls), callsPerMinute. Omit for conservative defaults.
Optional re-attempt rules for no-answer/busy/voicemail. Common keys: maxAttempts, retryAfterMinutes, retryOn (array of outcomes, e.g. ["no_answer","busy"]).
Optional answering-machine handling. Common keys: action ("hangup" | "leave_message"), messageText (used when action is leave_message).
Optional spend cap for the campaign