> ## 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, calls, campaigns, contacts, phone numbers, billing, and configuration. # Update outcome prompt > Set one editable outcome prompt. Required API key scope: `campaigns:write`. ## OpenAPI ````yaml /openapi.yaml patch /api/agent-builder/agents/{id}/outcome-prompts/{outcome} 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": "..." }` on failure. 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. - url: https://devapi.teamfollowup.ai description: Development API origin. Public API paths are under /api. security: [] tags: - name: Agents description: Manage voice agents, campaigns, workflows, and outcomes. - name: Analytics description: >- Minimal, non-billing performance summary: volume, conversion, and pickup metrics. - name: Calls description: Review calls, test runs, and execution history. - name: Campaign Workflows description: >- 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/digest` | 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: Contact list, filters, contact call history, and do-not-call actions. - name: GHL description: CRM variables and contact helpers used by agent and campaign setup flows. - name: Phone Numbers description: >- Caller ID pool, number search, assignment, movement, and release endpoints. - name: Power Dialer description: >- Power Dialer queue, lead cadence, callback, parked lead, and campaign schedule endpoints. - name: Projects description: >- Project management endpoints: list, update, disconnect, configure project campaigns, and validate setup. - name: Skills and Tools description: Manage reusable agent behaviors and in-call tool descriptions. - name: Voices description: Voice catalogue endpoints for choosing the voice used by an agent. paths: /api/agent-builder/agents/{id}/outcome-prompts/{outcome}: patch: tags: - Agents summary: Update outcome prompt description: |- Set one editable outcome prompt. Required API key scope: `campaigns:write`. operationId: patch-agent-builder-agents-by-id-outcome-prompts-by-outcome parameters: - name: id in: path required: true schema: type: string minLength: 1 description: Agent id. example: agent_1ffdb9717444d0e77346838911 - name: outcome in: path required: true schema: type: string enum: - opt_out - callback - human_needed - asked_for_info description: Outcome prompt key. example: opt_out requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AgentsSetOutcomePromptRequest' examples: default: value: prompt: Whether the lead explicitly asked not to be contacted again. responses: '200': description: Outcome prompt updated. content: application/json: schema: $ref: '#/components/schemas/AgentsSetOutcomePromptResponse' examples: default: value: success: true name: opt_out description: >- Whether the lead explicitly asked not to be contacted again. prompt: >- Whether the lead explicitly asked not to be contacted again. updated: true outcomePrompt: id: opt_out outcome: opt_out label: Opt out current: >- Whether the lead explicitly asked not to be contacted again. prompt: >- Whether the lead explicitly asked not to be contacted again. default: >- Whether the lead explicitly asked not to be contacted again. '400': description: Validation failed or the request body is malformed. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: VALIDATION message: prompt is required. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: >- Authenticated but missing the required `campaigns:write` scope or tenant access. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: FORBIDDEN message: No access to agent "agent_1ffdb9717444d0e77346838911". insufficientScope: value: success: false error: InsufficientScope message: This API key does not have the required scope. requiredScope: campaigns:write '404': description: Agent or related project not found. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: NOT_FOUND message: Agent "agent_1ffdb9717444d0e77346838911" not found. '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: TooManyRequests message: Too many requests, please try again later. '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: InternalError message: Unexpected server error. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request PATCH \ --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/outcome-prompts/{outcome} \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "prompt": "Whether the lead explicitly asked not to be contacted again." }' components: schemas: AgentsSetOutcomePromptRequest: type: object additionalProperties: {} required: - prompt properties: prompt: type: string minLength: 1 example: Whether the lead explicitly asked not to be contacted again. AgentsSetOutcomePromptResponse: type: object additionalProperties: false required: - success - name - description - prompt - updated - outcomePrompt properties: success: type: boolean name: type: string description: type: string prompt: type: string updated: type: boolean outcomePrompt: $ref: '#/components/schemas/AgentsOutcomePrompt' AgentsErrorResponse: type: object additionalProperties: {} required: - success - error - message properties: success: type: boolean error: type: string description: Machine-readable error code. example: VALIDATION message: type: string description: Human-readable explanation safe to show to an operator. example: locationId is required. references: type: object additionalProperties: {} description: Structured conflict details. Present on delete conflicts. details: type: array description: Field-level validation details when available. items: type: object additionalProperties: false required: - field - message properties: field: type: - string - 'null' example: locationId message: type: string example: locationId is required. AgentsOutcomePrompt: type: object additionalProperties: false required: - id - outcome - label - current - prompt - default properties: id: type: string example: opt_out outcome: type: string example: opt_out label: type: string example: Opt out current: type: string example: Whether the lead explicitly asked not to be contacted again. prompt: type: string example: Whether the lead explicitly asked not to be contacted again. default: type: string example: Whether the lead explicitly asked not to be contacted again. securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````