Campaigns API

A campaign decides who the agent calls and when. It is reached through its agent’s id, and every field is explained in What a campaign is.

Endpoint	Use it to
Get campaign	Read the campaign, including your wording for the four describable outcomes under `outcomes` and the cadence under `calling.cadence`.
Update campaign	Change tags, `dialing`, the calling window, `fromNumbers`, `config`, the cadence under `calling.cadence`, the number texts come from (`smsFromNumber`), one outcome’s wording under `outcomes`, or switch `active`.
Enroll existing leads	Push contacts already carrying the entry tag through the campaign. Dry-run first.
Create campaign test run	Send one contact through the real campaign entry.
Get campaign test run status	Poll what happened to it.

There is no separate project-side endpoint. Address the campaign by its agent id, and add locationId and campaignId when the agent is shared across projects. A TFU Live rep’s campaign is read and changed the same way, with its tfu_live: id and locationId: see Set up a TFU Live rep’s campaign. Scopes: campaigns:read, campaigns:write, and calls:write for test runs. See Authentication.

Guides

What a campaign is, Who gets called and Speed to lead and power dialer.
Calling window and Contact timezone.
Backfill existing leads and Test your agent.
Go live.
Glossary

Developer setup

Agents

TFU Live

In-call Capabilities

Campaigns

Master agent

Phone Numbers

Voices

Projects

Calls

Contacts

Native Contacts

Native Calendar

Analytics

Billing

Guides

​Guides

Guides