PaginatedResponse[CampaignBucketRead]

items object[]required

Array [

idIdrequired

Unique numeric identifier of the record.

campaign_idCampaign Idrequired

ID of the campaign this bucket belongs to.

nameNamerequired

Human-readable bucket (variant) name.

weight_pctWeight Pctrequired

Selection weight as a percentage (0–100). Across a campaign, active weights must total 100.

config objectrequired

The overrides this bucket applies (prompts, model config, outreach).

prompt_overrides object

Per prompt-type and language, the prompt/version to use instead of the agent's default.

property name* object

outreach_config_override object

Outreach setting overrides applied for this bucket.

anyOf

• BucketOutreachConfigOverride
• null

initial_message_send_at object

Override for when the initial outreach message is sent — HH:MM in UTC, the same contract as the campaign field. When set it also turns the campaign's instant_outreach off for leads assigned to this bucket; otherwise the planner would send at once and the bucket's timing experiment would never run.

anyOf

• string
• null

string

source object

Override for the outreach message source (content).

anyOf

• MessageSource
• null

text object

anyOf

• string
• null

string

prompt_id object

anyOf

• integer
• null

integer

prompt_version_id object

anyOf

• integer
• null

integer

prepared_message_id object

anyOf

• integer
• null

integer

waba_template_id object

anyOf

• integer
• null

integer

file_idsinteger[]

caption object

anyOf

• string
• null

string

subject object

Override for the message subject (email channels).

anyOf

• string
• null

string

models_config_override object

LLM model-config overrides applied for this bucket.

anyOf

• AgentModelsConfig
• null

chatbot_model_config object

anyOf

• LLMModelConfig
• null

vendorVendorrequired

Possible values: [chatgpt, gemini, anthropic, grok, sber, openrouter]

modelModelrequired

temperatureTemperature

Default value: 0.7

prompt_caching_enabledPrompt Caching Enabled

Default value: false

classification_model_config object

anyOf

• LLMModelConfig
• null

vendorVendorrequired

Possible values: [chatgpt, gemini, anthropic, grok, sber, openrouter]

modelModelrequired

temperatureTemperature

Default value: 0.7

prompt_caching_enabledPrompt Caching Enabled

Default value: false

ping_model_config object

anyOf

• LLMModelConfig
• null

vendorVendorrequired

Possible values: [chatgpt, gemini, anthropic, grok, sber, openrouter]

modelModelrequired

temperatureTemperature

Default value: 0.7

prompt_caching_enabledPrompt Caching Enabled

Default value: false

document_model_config object

anyOf

• LLMModelConfig
• null

vendorVendorrequired

Possible values: [chatgpt, gemini, anthropic, grok, sber, openrouter]

modelModelrequired

temperatureTemperature

Default value: 0.7

prompt_caching_enabledPrompt Caching Enabled

Default value: false

created_atdate-timerequired

Creation time (UTC, ISO 8601).

]

pagePagerequired

limitLimitrequired

totalTotalrequired

pagesPagesrequired

PaginatedResponse[CampaignBucketRead]

{
  "items": [
    {
      "id": 0,
      "campaign_id": 0,
      "name": "string",
      "weight_pct": 0,
      "config": {
        "prompt_overrides": {},
        "outreach_config_override": {
          "initial_message_send_at": "string",
          "source": {
            "text": "string",
            "prompt_id": 0,
            "prompt_version_id": 0,
            "prepared_message_id": 0,
            "waba_template_id": 0,
            "file_ids": [
              0
            ],
            "caption": "string"
          },
          "subject": "string"
        },
        "models_config_override": {
          "chatbot_model_config": {
            "vendor": "chatgpt",
            "model": "string",
            "temperature": 0.7,
            "prompt_caching_enabled": false
          },
          "classification_model_config": {
            "vendor": "chatgpt",
            "model": "string",
            "temperature": 0.7,
            "prompt_caching_enabled": false
          },
          "ping_model_config": {
            "vendor": "chatgpt",
            "model": "string",
            "temperature": 0.7,
            "prompt_caching_enabled": false
          },
          "document_model_config": {
            "vendor": "chatgpt",
            "model": "string",
            "temperature": 0.7,
            "prompt_caching_enabled": false
          }
        }
      },
      "created_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "page": 0,
  "limit": 0,
  "total": 0,
  "pages": 0
}