> ## Documentation Index
> Fetch the complete documentation index at: https://docs.teamfollowup.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the public API base URL: https://api.teamfollowup.ai/api.
> Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.
> Use product-owned terms: agents, campaigns, projects (GoHighLevel sub-accounts), contacts, calls, outcomes, skills, cadences, phone numbers.
> Scope requests by locationId rather than projectName.
> Read the guide linked from each API reference group before recommending an endpoint.

# Campaigns API

> The campaign attached to an agent: who it calls, when, how, and from which number. Plus the outcome prompts, backfill, and campaign test runs.

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](/campaigns/overview).

| Endpoint                                                                           | Use it to                                                                                |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| [Update campaign](/api-reference/agents/update-campaign)                           | Change tags, `dialing`, the calling window, `fromNumbers`, `config`, or switch `active`. |
| [Get outcome prompts](/api-reference/agents/get-outcome-prompts)                   | Read your wording for the four describable outcomes beside the defaults.                 |
| [Update outcome prompt](/api-reference/agents/update-outcome-prompt)               | Change one of them.                                                                      |
| [Enroll existing leads](/api-reference/agents/enroll-existing-leads)               | Push contacts already carrying the entry tag through the campaign. Dry-run first.        |
| [Create campaign test run](/api-reference/agents/create-campaign-test-run)         | Send one contact through the real campaign entry.                                        |
| [Get campaign test run status](/api-reference/agents/get-campaign-test-run-status) | Poll what happened to it.                                                                |

The same campaign is also reachable from the project side through
[Update project campaign](/api-reference/projects/update-project-campaign).

Scopes: `campaigns:read`, `campaigns:write`, and `calls:write` for test runs.
See [Authentication](/authentication#scopes).

## Guides

* [What a campaign is](/campaigns/overview), [Who gets called](/campaigns/audience)
  and [Speed to lead and power dialer](/campaigns/dispatch-modes).
* [Calling window](/campaigns/calling-window) and [Contact timezone](/campaigns/timezones).
* [Backfill existing leads](/campaigns/backfill-existing-leads) and
  [Test your agent](/agents/test-your-agent).
* [Go live](/campaigns/going-live).
* [Glossary](/glossary#campaigns)