Error codes

campaign_budget_reached

HTTP status: 402
Retry: No
Execution: Nothing was done
Admin needed: No

Campaign budget reached. The campaign's spend has reached its budget_cap. It will not dial again until the cap is raised or removed.

What it means

The API returns HTTP 402 with error.code set to campaign_budget_reached. The default message is: "This campaign has reached its budget cap."

Common causes

Spend on this campaign reached budget_cap.

How to identify it

Check the response status (402) and error.code (campaign_budget_reached). Branch on error.code, not on the message text: messages can be reworded, codes do not change within v1. Log error.request_id (also sent as the X-Request-Id header) so support can find the request.

How to fix it

Raise or clear budget_cap with PATCH /v1/campaigns/{campaign_id}, then start or resume.

Retry guidance

Sending the request unchanged fails the same way. Fix the cause first (see How to fix it), then send it again.

Did anything happen?

This request was refused before any call was placed and before anything was charged.

Idempotency

Nothing was done and the refusal is not stored under the Idempotency-Key. Fix the cause, then send the same request (with the same key if you sent one).

Who can fix it

The developer who sends the request can fix it; no administrator action is normally needed.

When to contact support

If the error persists after the steps above, contact support@relationsai.com. See Support for what to include (the request_id, the time in UTC, the operation, and whether you used a test or live key) and what never to send (API keys, Authorization headers, webhook signing secrets, recording links, transcripts or customer data).

Example error response

JSON
{
  "error": {
    "code": "campaign_budget_reached",
    "message": "This campaign has reached its budget cap.",
    "details": {
      "budget_cap": {
        "amount": 500000,
        "currency": "INR"
      }
    },
    "request_id": "req_bfxvre5lnjal5eiesdlhmcze",
    "retry": "no",
    "doc_url": "https://docs.relationsai.com/errors/campaign_budget_reached"
  }
}

Operations that can return this error

POST /campaigns/{campaign_id}/start: Start a campaign
POST /campaigns/{campaign_id}/resume: Resume a campaign

See all codes in the error-code reference.

legacy_api_key_not_supported insufficient_balance