> ## Documentation Index > Fetch the complete documentation index at: https://docs.ringg.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > To search or read these docs, connect the Ringg docs MCP server at https://docs.ringg.ai/mcp (no key needed; tools search_ringg_ai and query_docs_filesystem_ringg_ai) instead of browsing pages one by one. Setup for each client: https://docs.ringg.ai/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants.md > The dashboard labels agents "Assistants"; these docs say "agent". Both mean the same object, identified by agent_id. > API base URL: https://prod-api.ringg.ai/ca/api/v0. Send the workspace API key in the X-API-KEY header, from server-side code only. > Placing a call dials a real phone number and spends credits. Confirm the number with the user before calling. > To act on a Ringg workspace (place calls, edit agents, read transcripts), use the separate Ringg workspace MCP server at https://mcp.ringg.ai/mcp: https://docs.ringg.ai/resources/mcp-server/workspace-mcp-server/overview.md > Start a campaign uploaded with POST /campaign/save, taking caller numbers from a number pool that rotates numbers and skips ones flagged as spam. # Start Campaign (Number Pool) export const RelatedTopics = ({items}) =>
Related topics
{items.map(([title, href]) => {title} )}
; `list_id` is the one returned by [Upload campaign contact list](/api-reference/calling/campaigns/upload-campaign-contact-list); `agent_id` is the agent the list was uploaded for. Copy `number_pool_id` with **Copy pool ID** on the **Number pools** page ([Number pools](/documentation/inventory/phone-numbers/number-pools)). `email_completion_user_ids` are workspace user IDs from [List workspace users](/api-reference/account/list-workspace-users). ```json theme={null} { "agent_id": "your-agent-id", "list_id": "123e4567-e89b-12d3-a456-426614174000", "number_pool_id": "your-number-pool-id" } ``` The response, the balance requirement and the errors are the same as for [Start campaign](/api-reference/calling/campaigns/start-campaign). ## OpenAPI ````yaml post /campaign/v2/start openapi: 3.0.0 info: title: Ringg AI API Documentation description: >- The Ringg AI REST API. Base URL https://prod-api.ringg.ai/ca/api/v0; send your workspace API key in the X-API-KEY header from server-side code only. Requests and responses are JSON. version: 2.0.0 contact: name: Ringg AI support email: admin@ringg.ai url: https://docs.ringg.ai servers: - url: https://prod-api.ringg.ai/ca/api/v0 security: [] tags: - name: workspace description: Endpoints for managing your workspace. - name: agent description: Endpoints for managing agents. - name: calling description: Endpoints for making and managing calls. - name: campaign description: Endpoints for managing campaigns. - name: analytics description: Endpoints for accessing call analytics and performance metrics. - name: termination description: Endpoints for terminating active calls using different methods. - name: knowledgebase description: Endpoints for managing knowledge bases. paths: /campaign/v2/start: post: tags: - campaign summary: Start Campaign (Number Pool) description: >- Initiates a new campaign using a number pool for outbound calls. Ringg picks caller numbers from the pool, rotating numbers and skipping ones flagged as spam. operationId: startCampaignV2 parameters: - name: X-API-KEY in: header description: (Required) Your Ringg AI API key. required: true schema: type: string example: rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx requestBody: required: true content: application/json: schema: type: object required: - agent_id - list_id - number_pool_id properties: agent_id: type: string description: (Required) ID of the agent that will handle the calls. example: 00000000-0000-4000-8000-0000000000a1 list_id: type: string description: (Required) ID of the uploaded campaign contact list. example: 123e4567-e89b-12d3-a456-426614174000 number_pool_id: type: string description: >- (Required) ID of the managed number pool to use for outbound calls. example: 00000000-0000-4000-8000-0000000000b1 email_completion_user_ids: type: array items: type: string nullable: true description: User IDs to notify by email when the campaign completes. example: agent_id: 00000000-0000-4000-8000-0000000000a1 list_id: 123e4567-e89b-12d3-a456-426614174000 number_pool_id: 00000000-0000-4000-8000-0000000000b1 responses: '200': description: Campaign started successfully. content: application/json: schema: type: object properties: status: type: string description: Success message indicating campaign registration. example: campaign registered successfully! has_ongoing_calls: type: boolean description: Whether the workspace has other ongoing calls. example: false example: status: campaign registered successfully! has_ongoing_calls: false '400': description: Bad Request - Invalid input. content: application/json: schema: type: object properties: message: type: string example: Number pool not found. '401': description: Unauthorized - Invalid or missing authentication. content: application/json: schema: type: object properties: message: type: string example: Invalid credentials '402': description: >- Payment Required - The balance (or available credit limit) does not cover the campaign. content: application/json: schema: type: object properties: message: type: string example: >- your current balance is insufficient to complete this action '500': description: Internal Server Error. content: application/json: schema: type: object properties: message: type: string example: An unexpected error occurred. Please try again later. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.