Sign in

v1

latestOpenAPI 3.0.02026-07-2633090.6 KB
campaign

Start Campaign (Number Pool)

Initiates a new campaign using a managed number pool for outbound calls. Numbers are resolved automatically from the pool (rotation, spam skipping, auto-purchase).

post/campaign/v2/start

Headers

X-API-KEYstring required
Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Request body

agent_idstring required

(Required) ID of the agent that will handle the calls.

list_idstring required

(Required) ID of the uploaded campaign contact list.

number_pool_idstring required

(Required) ID of the managed number pool to use for outbound calls.

callback_urlstring nullable

URL to receive campaign completion webhook.

email_completion_user_idsstring[] nullable

User IDs to notify by email when the campaign completes.

Example request

{
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
  "list_id": "123e4567-e89b-12d3-a456-426614174000",
  "number_pool_id": "pool-uuid-here"
}

Response

Campaign started successfully.

statusstring

Success message indicating campaign registration.

has_ongoing_callsboolean

Whether the workspace has other ongoing calls.

Example response

{
  "status": "campaign registered successfully!",
  "has_ongoing_calls": false
}