Agent-readable docs index: /docs/llms.txt. Full docs in one file: /docs/llms-full.txt. Download /docs/docs.zip to grep all markdown files locally.

Get campaign

/campaigns/{id}GET
Fetches complete analytical breakdown and configuration of a specific broadcast campaign.
Authorization
BearerAuth *Bearer <token>
API key generated under Account Settings → API Keys (rk_live_...). Send as header Authorization: Bearer <key>.
Response
200 · Campaign detail object retrieved
id?integer
Example: 12
name?string
Example: "October Flash Sale"
subject?string
Example: "50% Discount Today"
preview_text?string
Example: "Limited time offer"
body?string
Example: "Hi {{first_name}}, claim your discount!"
status?string
Example: "sent"
campaign_type?string
Example: "broadcast"
routing_strategy?string
Example: "smart_fallback"
sent_count?integer
Example: 940
failed_count?integer
Example: 6
delivered_count?integer
Example: 934
actual_cost?number (float)
Example: 4700
scheduled_at?string (date-time) | null
created_at?string (date-time)
Example: "2026-07-20T10:00:00Z"
channel?string
Example: "whatsapp"
contact_list?object
Show properties
id?integer
Example: 3
name?string
Example: "All Customers"
401 · Unauthorized
success *boolean
Example: false
error *string
Human-readable error message explaining the failure reason.
Example: "Recipient not reachable on WhatsApp."
error_code *string
Stable machine-readable error code.
Example: "recipient_not_on_whatsapp"
404 · Resource not found
success *boolean
Example: false
error *string
Human-readable error message explaining the failure reason.
Example: "Recipient not reachable on WhatsApp."
error_code *string
Stable machine-readable error code.
Example: "recipient_not_on_whatsapp"
Request example
curl -X GET "https://convert.ruut.chat/api/v1/campaigns/12" \
  -H "Authorization: Bearer <token>"
Response example
{
  "id": 12,
  "name": "October Mega Flash Sale",
  "subject": "Exclusive 50% Off Today",
  "preview_text": "Don't miss our flash discounts",
  "body": "Hi {{first_name}}, use code FLASH50 at checkout!",
  "status": "sent",
  "campaign_type": "broadcast",
  "routing_strategy": "smart_fallback",
  "sent_count": 940,
  "failed_count": 6,
  "delivered_count": 934,
  "actual_cost": 4700,
  "scheduled_at": null,
  "created_at": "2026-07-20T10:00:00Z",
  "channel": "whatsapp",
  "contact_list": {
    "id": 3,
    "name": "Active VIP Customers"
  }
}