> ## 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.

# Check large campaign balance (Beta)

> Confirm workspace balance before starting beta large-campaign calls.

<Warning>
  This endpoint is beta. Use it only after upload processing is complete for a beta large campaign.
</Warning>

`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

```text theme={null}
POST /campaign/check-balance/{bulk_list_id}
```

## Path parameters

| Parameter      | Required | Description                                                    |
| -------------- | -------- | -------------------------------------------------------------- |
| `bulk_list_id` | Yes      | Large campaign list ID returned by `POST /campaign/upload-csv` |

## Request

```bash theme={null}
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.

```json theme={null}
{
  "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](/api-reference/endpoint/campaign/make-large-campaign-calls-async).


## OpenAPI

````yaml post /campaign/check-balance/{bulk_list_id}
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    This is the documentation for the Ringg AI APIs. The Ringg AI API follows
    RESTful principles, making it intuitive and easy to integrate with your
    applications. All API requests should be made to the base URL. The API
    accepts and returns data in JSON format. Ensure your requests include the
    appropriate Content-Type header for POST and PATCH requests.
  version: 2.0.0
servers:
  - url: https://prod-api.ringg.ai/ca/api/v0
security: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing assistants (agents).
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: Endpoints for accessing call analytics and performance metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /campaign/check-balance/{bulk_list_id}:
    post:
      tags:
        - campaign
      summary: Check Campaign Balance (Beta)
      description: >-
        Beta endpoint for re-checking workspace balance after a large campaign
        entered insufficient_balance status.
      operationId: checkCampaignBalanceBeta
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Ringg AI API key.
          required: true
          schema:
            type: string
            example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
        - name: bulk_list_id
          in: path
          required: true
          description: Bulk list ID to re-check.
          schema:
            type: string
      responses:
        '200':
          description: Balance check completed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: draft
                  bulk_list_id:
                    type: string
                  message:
                    type: string
        '401':
          description: Unauthorized - Invalid or missing authentication.
        '404':
          description: Bulk list not found.

````