Get large campaign upload status (Beta)

Poll asynchronous CSV processing status for a beta large campaign.

GET /campaign/upload-status/{bulk_list_id}

Get Campaign Upload Status (Beta)

cURL

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>'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/campaign/upload-status/{bulk_list_id}"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://prod-api.ringg.ai/ca/api/v0/campaign/upload-status/{bulk_list_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.ringg.ai/ca/api/v0/campaign/upload-status/{bulk_list_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.ringg.ai/ca/api/v0/campaign/upload-status/{bulk_list_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://prod-api.ringg.ai/ca/api/v0/campaign/upload-status/{bulk_list_id}")
  .header("X-API-KEY", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/campaign/upload-status/{bulk_list_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

200

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

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

Parameter	Required	Description
bulk_list_id	Yes	Large 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

Status	Meaning	Next action
uploaded	Ringg accepted the CSV and queued processing	Keep polling
processing	Rows are being parsed and validated	Keep polling
completed	Processing finished and valid rows are ready	Check balance
failed	Processing could not complete	Fix 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

200

application/json

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"