Skip to main content
POST
/
campaign
/
check-balance
/
{bulk_list_id}
Check Campaign Balance (Beta)
curl --request POST \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id} \
  --header 'X-API-KEY: <x-api-key>'
{
  "status": "draft",
  "bulk_list_id": "<string>",
  "message": "<string>"
}
This endpoint is beta. Use it only after upload processing is complete for a beta large campaign.
POST /campaign/check-balance/{bulk_list_id} checks whether the workspace has enough balance to start calls for the validated rows in a large campaign.

​
Endpoint

POST /campaign/check-balance/{bulk_list_id}

​
Path parameters

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

​
Request

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

​
Response guidance

A successful response confirms whether the current balance can cover the validated campaign rows. 
{
  "bulk_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "required_credits": 6200,
  "available_credits": 8500,
  "sufficient_balance": true
}
If sufficient_balance is false, add balance, reduce the campaign size, or contact Ringg support before starting calls.

​
Next step

When balance is sufficient, call Make large campaign calls async.

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 to re-check.

Response

Balance check completed.

​
status
string
Example:

"draft"

​
bulk_list_id
string
​
message
string