Skip to main content
GET
/
campaign
/
upload-status
/
{bulk_list_id}
Get Campaign Upload Status (Beta)
curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/upload-status/{bulk_list_id} \
  --header 'X-API-KEY: <x-api-key>'
{
  "bulk_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "verifying",
  "campaign_name": "Renewal reminders - large upload",
  "total_callees": 5000,
  "invalidated_rows_count": 12,
  "invalidated_rows_csv_url": "https://storage.example.com/invalid-rows.csv"
}

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.

This endpoint is beta. Use it only for lists created with Upload large campaign CSV.
GET /campaign/upload-status/{bulk_list_id} returns the processing state for a large campaign CSV upload.

​
Endpoint

GET /campaign/upload-status/{bulk_list_id}

​
Path parameters

ParameterRequiredDescription
bulk_list_idYesLarge campaign list ID returned by POST /campaign/upload-csv

​
Request

curl --request GET "https://prod-api.ringg.ai/ca/api/v0/campaign/upload-status/your-bulk-list-id" \
  --header "X-API-KEY: $RINGG_API_KEY"

​
Status flow

StatusMeaningNext action
uploadedRingg accepted the CSV and queued processingKeep polling
processingRows are being parsed and validatedKeep polling
completedProcessing finished and valid rows are readyCheck balance
failedProcessing could not completeFix the CSV and upload again
Some beta workspaces may return equivalent status names such as ready for a completed upload. Continue only when the response clearly indicates that CSV processing has finished.

​
Response guidance

The response includes the upload state and may include row counts or validation details. 
{
  "bulk_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "processing",
  "total_rows": 6200,
  "processed_rows": 2800,
  "successful_rows": 2744,
  "failed_rows": 56
}

​
Next step

When processing is complete, call Check large campaign balance. If the response shows invalid rows, fix and re-upload the CSV unless your workflow intentionally removes invalid rows.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Path Parameters

​
bulk_list_id
string
required

Bulk list ID returned by /campaign/upload-csv.

Response

Upload status returned successfully.

​
bulk_list_id
string
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
status
string
Example:

"verifying"

​
campaign_name
string
Example:

"Renewal reminders - large upload"

​
total_callees
integer
Example:

5000

​
invalidated_rows_count
integer
Example:

12

​
invalidated_rows_csv_url
string | null
Example:

"https://storage.example.com/invalid-rows.csv"