v1

latestOpenAPI 3.0.02026-07-2633090.6 KB

campaign

Get Campaign Upload Status (Beta)

Beta endpoint for checking asynchronous CSV validation status before starting a large campaign.

get/campaign/upload-status/{bulk_list_id}

Path parameters

bulk_list_idstring required

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

Headers

X-API-KEYstring required

Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Response

Upload status returned successfully.

bulk_list_idstring

statusstring

campaign_namestring

total_calleesinteger

invalidated_rows_countinteger

invalidated_rows_csv_urlstring nullable

Example response

{
  "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"
}