Skip to main content

CampaignBucketBulkUpsertPayload

Payload to replace a campaign's full set of buckets atomically.

buckets object[]required

The complete desired set of buckets; existing buckets are matched by id, others are created.

  • Array [
    • id object

    ID of an existing bucket to update; omit to create a new bucket.

    anyOf
    integer
    nameNamerequired

    Bucket name.

    weight_pctWeight Pctrequired

    Selection weight percentage (0–100).

    config object

    The overrides this bucket applies.

    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
    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
    source object

    Override for the outreach message source (content).

    anyOf
    text object
    anyOf
    string
    prompt_id object
    anyOf
    integer
    prompt_version_id object
    anyOf
    integer
    prepared_message_id object
    anyOf
    integer
    waba_template_id object
    anyOf
    integer
    file_idsinteger[]
    caption object
    anyOf
    string
    subject object

    Override for the message subject (email channels).

    anyOf
    string
    models_config_override object

    LLM model-config overrides applied for this bucket.

    anyOf
    chatbot_model_config object
    anyOf
    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
    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
    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
    vendorVendorrequired

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

    modelModelrequired
    temperatureTemperature
    Default value: 0.7
    prompt_caching_enabledPrompt Caching Enabled
    Default value: false
  • ]
    • CampaignBucketBulkUpsertPayload
    {
      "buckets": [
        {
          "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
              }
            }
          }
        }
      ]
    }