id, and every field is explained in
What a campaign is.
The same campaign is also reachable from the project side through
Update project campaign.
Scopes:
campaigns:read, campaigns:write, and calls:write for test runs.
See Authentication.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The campaign attached to an agent: who it calls, when, how, and from which number. Plus the outcome prompts, backfill, and campaign test runs.
id, and every field is explained in
What a campaign is.
| Endpoint | Use it to |
|---|---|
| Update campaign | Change tags, dialing, the calling window, fromNumbers, config, or switch active. |
| Get outcome prompts | Read your wording for the four describable outcomes beside the defaults. |
| Update outcome prompt | Change one of them. |
| 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. |
campaigns:read, campaigns:write, and calls:write for test runs.
See Authentication.
