> ## 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. # Validate project campaign agent > Validate whether the campaign agent has the fields and variables expected by its selected campaign system. Customer role: `agency_admin`. Required API key scope: `projects:read`. ## OpenAPI ````yaml /openapi.yaml get /api/v2/projects/{id}/campaigns/{campaignId}/validate 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/v2/projects/{id}/campaigns/{campaignId}/validate: get: tags: - Projects summary: Validate project campaign agent description: >- Validate whether the campaign agent has the fields and variables expected by its selected campaign system. Customer role: `agency_admin`. Required API key scope: `projects:read`. operationId: get-v2-projects-by-id-campaigns-by-campaignId-validate parameters: - name: id in: path required: true schema: type: string minLength: 1 description: Project id. example: 64f2a8c8a2b3c4d5e6f7a8b9 - name: campaignId in: path required: true schema: type: string minLength: 1 description: Campaign id. example: campaign_speed_to_lead_123 responses: '200': description: Campaign agent validation result. content: application/json: schema: $ref: '#/components/schemas/ProjectsCampaignValidationResponse' examples: default: value: success: true data: ok: false system: appointment_booking agentName: Front Desk Agent missing: postCallFields: - name: appointment_booked type: boolean promptVars: - availability present: postCallFields: - call_summary - callback promptVars: - first_name - phone extra: postCallFields: - name: custom_note type: string metadataVars: - contact_id - location_id '400': description: Validation failed or the request is malformed. content: application/json: schema: $ref: '#/components/schemas/ProjectsErrorResponse' examples: default: value: success: false error: VALIDATION message: businessName is required. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/ProjectsErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: Authenticated but not permitted to access the requested resource. content: application/json: schema: $ref: '#/components/schemas/ProjectsErrorResponse' examples: default: value: success: false error: Forbidden message: You do not have permission to access this resource. '404': description: Resource not found or not visible to the caller. content: application/json: schema: $ref: '#/components/schemas/ProjectsErrorResponse' examples: default: value: success: false message: Project not found. '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ProjectsErrorResponse' 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/ProjectsErrorResponse' examples: default: value: success: false error: InternalError message: Unexpected server error. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/v2/projects/{id}/campaigns/{campaignId}/validate \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: ProjectsCampaignValidationResponse: type: object additionalProperties: false required: - success - data properties: success: type: boolean data: $ref: '#/components/schemas/ProjectsCampaignValidation' ProjectsErrorResponse: type: object additionalProperties: {} required: - success properties: success: type: boolean error: type: string example: VALIDATION code: type: string example: SubAccountCapReached message: type: string example: Project not found. ProjectsCampaignValidation: type: object additionalProperties: {} required: - ok - missing properties: ok: type: boolean example: false error: type: string example: No agent ID on campaign system: type: string example: appointment_booking agentName: type: string example: Front Desk Agent missing: type: object additionalProperties: false required: - postCallFields - promptVars properties: postCallFields: type: array items: $ref: '#/components/schemas/ProjectsValidationField' promptVars: type: array items: type: string example: - availability present: type: object additionalProperties: {} properties: postCallFields: type: array items: type: string example: - call_summary - callback promptVars: type: array items: type: string example: - first_name - phone extra: type: object additionalProperties: {} properties: postCallFields: type: array items: $ref: '#/components/schemas/ProjectsValidationField' metadataVars: type: array items: type: string example: - contact_id - location_id ProjectsValidationField: type: object additionalProperties: false required: - name - type properties: name: type: string example: appointment_booked type: type: string example: boolean securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````