> ## 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. # Pause TFU Live agent > Switch the rep’s campaign off, as the dashboard’s pause does, through the same campaign update. Once paused, the rep calls no leads, and a call to its numbers is answered as its phone test: the same conversation with every action simulated, nothing written to the CRM or calendar, billed as a test call. Its settings, numbers and start tags are kept, so Go live with TFU Live agent switches it back on, past the same go-live check. It works whatever would stop the rep going live. Pausing a campaign that is already paused, or a rep with no campaign on this sub-account, changes nothing (unchanged). Machine credentials use the returned tfu_live: agent id, and need `agents:write` as well, as every change to a TFU Live agent does. Required scope: `campaigns:write`. Required API key scope: `campaigns:write`. ## OpenAPI ````yaml /openapi.yaml post /api/tfu-live-agents/{id}/pause openapi: 3.1.0 info: title: TFUAI Server API version: 1.0.0 description: >- API reference for the TFUAI SaaS server. All published endpoints are mounted under `/api`. Responses use a standard envelope: `{ "success": true, ... }` on success and `{ "success": false, "error": "", "message": "..." }` on failure. Branch on the `error` code; `message` is for people and its wording can change. Product API modules are being launched module by module. This spec currently exposes only contracted public modules. Authenticate public API requests with an API key in the `Authorization` header: `Authorization: Bearer YOUR_API_KEY`. servers: - url: https://api.teamfollowup.ai description: Production API origin. Public API paths are under /api. security: [] tags: - name: Agents description: >- Build the conversation: identity and settings, script, lead context and split testing. - name: Analytics description: >- Understand call volume, pickup, booking and transfer metrics within the selected reporting scope. - name: Billing description: >- Balances, spend, purchases and sub-account rebilling. Reference and guides only; the builder chatbot has no billing playbook. - name: Calls description: >- Review completed calls, recordings, transcripts and campaign run history; distinguish observation from placing a new call. - name: Campaigns description: >- Configure what starts calls, who is eligible, calling windows, caller IDs, activation and the actions that follow each outcome. What runs after a call lands: for each outcome (booked, opted out, asked for a callback…), an ordered chain of actions — tag the contact, move a pipeline stage, send an SMS, book an appointment. Stored as a graph: `nodes` are the actions, `edges` say what follows what, and `dispositionEntries` maps each outcome to the node its chain starts at. **Pick the narrowest endpoint that does the job.** | To | Call | | | --- | --- | --- | | See what fires per outcome | `GET .../workflow?view=summary` | Reads as plain text, no graph walking | | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server derives node ids, edge ids, handles, layout | | Change a message, tag or setting | `PATCH .../workflow` | Merges; carries no graph, so it cannot damage one | | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain around it | | Author or replace the whole graph | `PUT .../workflow` | Replaces everything you send | `PUT` is the only one that can re-wire, position nodes, build an `if`, save an unconfigured draft, or copy a whole workflow — and the only one that can overwrite a change someone else made after you read it. Use it when you are genuinely authoring the graph, and send `expectedVersion` when you do. For everything else the narrower endpoints are both easier and safer. - name: Contacts description: >- Find contacts and their calls, manage do-not-call status and identify internal contacts excluded from reporting. - name: In-call Capabilities description: >- Configure actions and instructions the agent uses during a live call: booking, transfers, lookups and custom skills. - name: Master agent description: >- Run a shared agent and campaign across linked projects; manage inheritance, local bindings, synchronization and rollout readiness. - name: Native Calendar description: >- The diary of a sub-account with no CRM: its bookable calendars, the free slots they offer, and the appointments on them. Availability is computed per request against live bookings and is never cached, because a cached slot is one somebody else has already taken. - name: Native Contacts description: >- The people a sub-account with no CRM calls, and the fields it keeps on them. This is the system of record for those contacts: there is nowhere else they exist. A sub-account with a CRM keeps its contacts there and every operation here answers 400 for it. - name: Phone Numbers description: >- Find and manage caller IDs, assign numbers to campaigns and understand connected Twilio numbers. - name: Projects description: >- Understand project ownership, inspect configuration and validate the local resources used by a campaign. - name: TFU Live description: >- Configure instructions, conversation style, workflows, Chat and call handling, then test and go live. - name: Voices description: >- Browse the voice catalogue and select a voice; configure speech and listening behavior in Agents. paths: /api/tfu-live-agents/{id}/pause: post: tags: - TFU Live summary: Pause TFU Live agent description: >- Switch the rep’s campaign off, as the dashboard’s pause does, through the same campaign update. Once paused, the rep calls no leads, and a call to its numbers is answered as its phone test: the same conversation with every action simulated, nothing written to the CRM or calendar, billed as a test call. Its settings, numbers and start tags are kept, so Go live with TFU Live agent switches it back on, past the same go-live check. It works whatever would stop the rep going live. Pausing a campaign that is already paused, or a rep with no campaign on this sub-account, changes nothing (unchanged). Machine credentials use the returned tfu_live: agent id, and need `agents:write` as well, as every change to a TFU Live agent does. Required scope: `campaigns:write`. Required API key scope: `campaigns:write`. operationId: post-tfu-live-agents-by-id-pause parameters: - name: locationId in: query required: true schema: type: string description: >- Sub-account belonging to the authenticated agency and any narrower credential location binding. - name: id in: path required: true schema: type: string description: TFU Live agent id. Never use an ordinary provider agent id. - name: campaignId in: query schema: type: string pattern: ^[a-zA-Z0-9_-]{1,100}$ description: >- When more than one campaign uses this rep, the one to switch. Without it, the rep’s first campaign, the one Check TFU Live go-live readiness reads. requestBody: description: Request payload. _Detailed schema pending — see the route handler._ content: application/json: schema: type: object additionalProperties: {} responses: '200': description: The rep’s campaign as it is now, and whether this call changed it. content: application/json: schema: $ref: '#/components/schemas/TfuLiveCampaignSwitchResponse' example: success: true data: campaign: id: cmp_123 name: Consultation desk isActive: false live: false unchanged: false '400': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' example: success: false error: invalid_request message: Some details are missing. Please fill them in and try again. code: invalid_request '401': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' example: success: false error: Unauthorized message: Please sign in to continue. '403': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' example: success: false error: InsufficientScope message: >- This access key does not allow this action. Please ask your account admin to change its permissions. requiredScope: campaigns:write '404': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' example: success: false error: not_found message: >- We couldn't find that agent. Please refresh and choose another. code: not_found '409': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' example: success: false error: conflict message: >- This changed while you were working on it. Please refresh and try again. code: conflict '422': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' examples: blocked: summary: Not ready to go live value: success: false error: TFU_LIVE_GO_LIVE_BLOCKED message: >- Some setup steps are unfinished. Please finish them before going live. code: TFU_LIVE_GO_LIVE_BLOCKED blockers: - code: no_caller_id who: rep message: Choose the number I call from. - code: card_required who: operator page: /billing#overview message: >- Adding a card is something you do yourself: add a payment method to your agency wallet on the billing page. Free web test minutes cannot place phone calls. body: summary: A body was sent value: success: false error: invalid_request message: >- Some details need fixing. Please check the highlighted fields. code: invalid_request '429': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' example: success: false error: TooManyRequests message: That's a lot at once. Please wait a moment and try again. '502': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' example: success: false error: provider_unavailable message: This isn't available right now. Please try again in a moment. code: provider_unavailable ref: 3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b '503': description: >- TFU Live refused the request: { success: false, error, message, code, workflowId?, stepId?, field?, setupItems? }. Branch on error (code holds the same value), show message to people, and read the current agent before retrying. content: application/json: schema: $ref: '#/components/schemas/TfuLiveError' example: success: false error: TFU_LIVE_CAMPAIGN_PENDING message: >- Your agent draft was saved. Please try creating it again to finish attaching its campaign. code: TFU_LIVE_CAMPAIGN_PENDING ref: 3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request POST \ --url https://api.teamfollowup.ai/api/tfu-live-agents/{id}/pause \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: TfuLiveCampaignSwitchResponse: type: object required: - success - data properties: success: const: true data: type: object required: - campaign - live - unchanged additionalProperties: false properties: campaign: type: - object - 'null' required: - id - name - isActive additionalProperties: false description: >- The rep’s campaign as it is now. Null only when pausing a rep that has no campaign on this sub-account. properties: id: type: string name: type: - string - 'null' isActive: type: boolean description: Switched on. live: type: boolean description: >- The campaign is switched on: the rep places and answers real calls through it. unchanged: type: boolean description: It already was as asked, so nothing changed. additionalProperties: false TfuLiveError: type: object description: >- A TFU Live refusal: the standard error envelope, plus where a workflow refusal points and what setup still needs. required: - success - error - message properties: success: type: boolean example: false error: type: string description: >- The refusal’s code, the same value as code. A shared gate (authentication, scope, rate limit) answers with its own code, such as Unauthorized, InsufficientScope or TooManyRequests, and sends no code. message: type: string description: >- One plain sentence for a person: what happened and what to do next. Show it, never parse it: the wording can change, and browser users get it in their own language. API keys and OAuth apps always get English. example: We couldn't find that. It may have been moved or deleted. errors: type: array description: >- Sent when specific fields were refused: one entry for each field to fix. items: type: object additionalProperties: false required: - field - code - message properties: field: type: string description: Where the value sits in the request, as a dotted path. example: name code: type: string description: A stable code for what is wrong with the value. example: FieldRequired message: type: string description: One plain sentence for a person. example: Please fill this in. details: type: object additionalProperties: {} description: >- Data your code may need to act on the failure, such as ids or limits. Never text for people. ref: type: string description: >- Sent only when the failure was on our side. Quote it to support so they can find the request. It matches the `x-request-id` response header. example: 3f2b8c1e-7d4a-4f8e-9b6a-2c1d0e5f7a9b code: type: string enum: - invalid_workflow - setup_incomplete - workflow_resource_not_found - workflow_resource_unavailable - workflow_secret_refused - invalid_agent - invalid_request - unauthorized - insufficient_balance - forbidden - not_found - conflict - too_large - provider_unavailable - internal_error - AGENT_OPERATION_UNSUPPORTED - TFU_LIVE_CAMPAIGN_PENDING - TFU_LIVE_CAMPAIGN_REFUSED - TFU_LIVE_ALREADY_ON_GOHIGHLEVEL - TFU_LIVE_CONNECTION_NOT_CONFIGURED - TFU_LIVE_GO_LIVE_BLOCKED description: >- The same code as error, kept for integrations built before error carried it. The kind of refusal: invalid_workflow (a workflow’s structure or a node’s settings), setup_incomplete (a setting still to fill or a Brain template placeholder still in the prompt, where the agent must be complete: preparing it, or a save that sets it up; setupItems lists every one), workflow_resource_not_found (a calendar, custom field, pipeline stage, team or rep the sub-account lacks, or an inactive calendar), workflow_resource_unavailable (503: the sub-account’s resources could not be read; retry), workflow_secret_refused (a secret header rule), invalid_agent (any other part of the agent), else by status. TFU_LIVE_* names a product state. workflowId: type: string description: >- The workflow a workflow refusal is about. Absent on a workflow being created, which has no id yet. stepId: type: string description: The step inside it. field: type: string description: >- The setting inside the step: calendarId, routing[1].calendarId, items[0].field, destination.teamId, headers.Authorization; brain.prompt for a placeholder. On a create from a Brain template, the request value: values., values or brainTemplateId. setupItems: type: array items: type: object required: - kind - message additionalProperties: false description: >- Something the agent still needs before it can be prepared for real calls. properties: kind: type: string enum: - workflow_setting - prompt_placeholder description: >- workflow_setting: a setting still to fill (a calendar, a tag, who takes a transfer, zip codes, a choice’s answers, an item’s label); prompt_placeholder: a Brain template [bracketed] placeholder still in the prompt (legacy: templates no longer hold any). workflowId: type: string workflowName: type: string stepId: type: string node: type: string description: The node type. field: type: string description: >- The setting inside the step (calendarId, destination, items[0].choices), or brain.prompt. placeholder: type: string message: type: string description: What to do about it, for a person. description: >- On setup_incomplete: everything the agent still needs, the first of which the refusal names. blockers: type: array items: type: object required: - code - who - message additionalProperties: false description: One thing that stops the rep’s campaign from taking real calls. properties: code: type: string description: >- What it is, such as no_caller_id, no_trigger_tag, not_prepared, calling_line_not_ready, needs_gohighlevel or card_required. who: type: string enum: - rep - operator - staff description: >- Who clears it. rep: a setting of the rep’s own (its number, its trigger, its setup); operator: the person (approve GoHighLevel, add a card, upgrade the plan); staff: Team Follow Up. message: type: string description: >- What to do about it. An API key or OAuth client gets the go-live check’s own words. page: type: string description: >- Where a person does it in the dashboard, when there is a page for it. place: type: object additionalProperties: false required: - workflowId - stepId description: The workflow step it is about, when it is about one. properties: workflowId: type: string stepId: type: string description: >- On TFU_LIVE_GO_LIVE_BLOCKED: everything standing between the rep’s campaign and real calls, as Check TFU Live go-live readiness lists it. The campaign stayed paused. additionalProperties: {} securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.