FRfreyavoice
Campaigns

Create campaign

Creates an outbound voice campaign and schedules calls to the provided customers.

post/campaign

Request

  • Base URL
    https://app.freyavoice.ai/api/v2
  • Auth
    HTTP bearer

Request body

namestring required
assistantIdstring

ID of the AI assistant

assistantNamestring

Name of the AI assistant (alternative to assistantId)

descriptionstring
startDatestring date

When campaign starts (YYYY-MM-DD). Omit for immediate start.

startTimestring

Time on start date (HH:MM). Also defines retry window start.

timezonestring

IANA timezone for all times (e.g., Europe/Prague)

endTimestring

Daily retry window end (HH:MM). Retries only happen between startTime-endTime.

activeDaysinteger[]

Days retries can happen (0=Monday, 6=Sunday)

phoneNumberstring

Caller ID phone number

callRetriesinteger

Number of retry attempts (0-10)

retryDelaySecondsinteger

Delay between retries in seconds (0-86400)

retryDelayMode'fixed' | 'next_day'
retryConditionsstring[]

Array of call outcome values to retry on (SipCodeCategory + special endedReason values)

webhookUrlstring
phoneListstring[]

Simple list of phone numbers (alternative to customers)

workspaceIdstring

Response

Campaign created

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.