Skip to main content
GET
/
api
/
campaigns
/
settings
Get Campaign Settings
curl --request GET \
  --url https://app.puffle.ai/api/campaigns/settings \
  --header 'Authorization: Bearer <token>'
{
  "accounts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "provider_account_id": "<string>",
      "is_premium": true,
      "weekly_connection_limit": 4503599627370495,
      "weekly_message_limit": 4503599627370495,
      "display_name": "<string>",
      "email_address": "<string>",
      "status": "<string>",
      "daily_limit": 4503599627370495,
      "weekly_stats": {
        "connections_sent": 4503599627370495,
        "messages_sent": 4503599627370495
      },
      "limits": {
        "weekly_connection_limit": 4503599627370495,
        "weekly_message_limit": 4503599627370495,
        "max_connection_limit": 4503599627370495,
        "max_message_limit": 4503599627370495,
        "recommended_connection_limit": 4503599627370495,
        "recommended_message_limit": 4503599627370495
      },
      "daily_stats": {
        "sent": 4503599627370495,
        "daily_limit": 4503599627370495
      }
    }
  ],
  "schedules": [
    "<unknown>"
  ],
  "weekly_stats": [
    "<unknown>"
  ]
}
CLI:
puffle campaign setting

Overview

Returns the campaign settings surface for the caller, including connected campaign-capable accounts, their current limits, and recent usage. Use this for settings screens and agent checks before changing limits.

AI agent notes

Call this before changing campaign sender limits. Each account includes current usage, current limits, recommended limits, and maximum limits. Respect the returned maximums. Sender limits are account-level pacing controls, not per-campaign counters; changing them affects every campaign that can send through that account.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Campaign sender settings for the caller.

accounts
object[]
required
schedules
any[]
weekly_stats
any[]