API ReferenceCampaigns

Create campaign

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Request

This endpoint expects an object.
flowIdstringRequiredformat: "uuid"

Flow (conversation script) to use for all calls

fromPhoneNumberstringRequired
Caller ID phone number in E.164 format
namestringRequired

Human-readable name for the campaign

providerIdstringRequiredformat: "uuid"
VoIP provider to route calls through
allowedDayslist of integers or nullOptional

DEPRECATED: Use call_windows instead. Allowed days of week (1=Monday through 7=Sunday)

callWindowslist of objects or nullOptional
Call time windows in UTC, if empty or not provided calls are allowed anytime
concurrentCallsintegerOptional

Maximum number of simultaneous calls (1-50), defaults to 5

descriptionstring or nullOptional
Optional description of the campaign purpose
earliestCallTimestring or nullOptional

DEPRECATED: Use call_windows instead. Earliest time to call (HH:MM)

endAtdatetime or nullOptional

End time after which the campaign auto-pauses, must be after start_at

latestCallTimestring or nullOptional

DEPRECATED: Use call_windows instead. Latest time to call (HH:MM)

respectContactTimezonebooleanOptional
Whether to check each contact's timezone before calling, defaults to true
startAtdatetime or nullOptional
Scheduled start time, if null user must manually start the campaign

Response

Campaign created
allowedDayslist of integers

DEPRECATED: Use call_windows instead. Allowed days of week

callWindowslist of objects
Call time windows in UTC
concurrentCallsinteger
Maximum number of simultaneous calls
createdAtdatetime
When the campaign was created
earliestCallTimestring

DEPRECATED: Use call_windows instead. Earliest call time in HH:MM

flowIdstringformat: "uuid"

Flow (conversation script) used for all calls

fromPhoneNumberstring
Caller ID phone number in E.164 format
idstringformat: "uuid"
Unique identifier for the campaign
latestCallTimestring

DEPRECATED: Use call_windows instead. Latest call time in HH:MM

namestring

Human-readable name for the campaign

progressobject
Contact processing progress counters
providerIdstringformat: "uuid"
VoIP provider used for routing
respectContactTimezoneboolean
Whether each contact's timezone is checked before calling
sourcestring

Driving subsystem: user (standard campaign) or meta_lead (auto-created envelope grouping Meta Lead Ads calls; fed on lead arrival, not by the scheduler)

statusenum
Current status of the campaign
completedAtdatetime or nullOptional
When the campaign finished processing all contacts
descriptionstring or nullOptional
Description of the campaign purpose
endAtdatetime or nullOptional

End time after which the campaign auto-pauses

flowNamestring or nullOptional

Display name of the flow. Null when the flow has since been deleted — the campaign still renders, it just has no name to show.

flowVersionstring or nullOptional
Pinned flow version at time of campaign creation
metricsobject or nullOptional
Aggregated call metrics for a campaign
pauseReasonenum or nullOptional
Reason why a campaign was paused
pausedAtdatetime or nullOptional
When the campaign was paused
startAtdatetime or nullOptional
Scheduled start time in UTC
startedAtdatetime or nullOptional
When the campaign was started

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error