Skip to main content

OutreachCampaignCreate

Payload to create an outreach campaign. The agent must belong to the given product.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

nameNamerequired

Human-readable campaign name.

outreach_to_stage_id object

ID of the pipeline stage whose leads to target.

anyOf
integer
statusOutreachCampaignStatus

Initial status; defaults to "draft".

Possible values: [draft, active, paused, stopped, finished]

Default value: draft
config object

Outreach behavior configuration. Defaults to the standard outreach config.

outreach_enabledOutreach Enabled
Default value: false
persist_channel_in_outreachPersist Channel In Outreach
Default value: false
instant_outreachInstant Outreach
Default value: false
run_post_outreach_state_treeRun Post Outreach State Tree
Default value: false
initial_message_send_atInitial Message Send At
Default value: 10:30
source object
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
crm_fields_conditions object
anyOf
operatorCRMFieldsConditionsOperator

Possible values: [AND, OR]

Default value: AND
conditions object[]
  • Array [
    • fieldFieldrequired
    operatorCRMFieldConditionOperatorrequired

    Possible values: [EQUALS, NOT_EQUALS, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, EXISTS, NOT_EXISTS, IS_EMPTY, IS_NOT_EMPTY]

    valueValue
  • ]
    • lead_batch_namesstring[]
    wait_after_lead_stage_at_secondsWait After Lead Stage At Seconds
    Default value: 0
    outreach_priorityOutreach Priority

    Which campaign claims shared channel capacity first when several campaigns on one agent compete for it, from 0 (default, lowest) to 10 (highest). Higher priority claims first on each scheduler pass; campaigns of equal priority rotate by least recently evaluated. The priority is soft — it only orders claims and reserves nothing, so a higher-priority campaign with no eligible leads yields its share to the others. A campaign that always has demand at a higher priority can leave lower-priority campaigns without capacity for the rest of the day; that is expected behavior.

    Possible values: >= 0 and <= 10

    Default value: 0
    dispatch_steps object[]
  • Array [
    • channel_typeChannel Typerequired

    Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]

    ext_channel_id object
    anyOf
    string
    contact_typeContactType

    Possible values: [phone, username, chat_id, email]

    Default value: phone
    no_reply_timeout_secondsNo Reply Timeout Seconds
    Default value: 86400
    no_send_confirmation_timeout_secondsNo Send Confirmation Timeout Seconds
    Default value: 3600
    advance_only_without_send_confirmationAdvance Only Without Send Confirmation
    Default value: false
    max_contactsMax Contacts
    Default value: 1
    outreach_daily_limitOutreach Daily Limit
    Default value: 0
    non_connection_modeNon Connection Mode

    Possible values: [invite, inmail, skip]

    Default value: invite
    invite_with_noteInvite With Note
    Default value: false
    invite_note object
    anyOf
    string
    acceptance_wait_secondsAcceptance Wait Seconds
    Default value: 1209600
  • ]
    • subject object
    anyOf
    string
    first_cold_outreach_uses_lead_created_at_for_waba_windowFirst Cold Outreach Uses Lead Created At For Waba Window
    Default value: false
    started_at object

    Optional explicit start time (UTC).

    anyOf
    date-time
    stopped_at object

    Optional explicit stop time (UTC).

    anyOf
    date-time
    OutreachCampaignCreate
    {
      "product_id": 0,
      "agent_id": 0,
      "name": "string",
      "outreach_to_stage_id": 0,
      "status": "draft",
      "config": {
        "outreach_enabled": false,
        "persist_channel_in_outreach": false,
        "instant_outreach": false,
        "run_post_outreach_state_tree": false,
        "initial_message_send_at": "10:30",
        "source": {
          "text": "string",
          "prompt_id": 0,
          "prompt_version_id": 0,
          "prepared_message_id": 0,
          "waba_template_id": 0,
          "file_ids": [
            0
          ],
          "caption": "string"
        },
        "crm_fields_conditions": {
          "operator": "AND",
          "conditions": [
            {
              "field": "string",
              "operator": "EQUALS"
            }
          ]
        },
        "lead_batch_names": [
          "string"
        ],
        "wait_after_lead_stage_at_seconds": 0,
        "outreach_priority": 0,
        "dispatch_steps": [
          {
            "channel_type": "telegram",
            "ext_channel_id": "string",
            "contact_type": "phone",
            "no_reply_timeout_seconds": 86400,
            "no_send_confirmation_timeout_seconds": 3600,
            "advance_only_without_send_confirmation": false,
            "max_contacts": 1,
            "outreach_daily_limit": 0,
            "non_connection_mode": "invite",
            "invite_with_note": false,
            "invite_note": "string",
            "acceptance_wait_seconds": 1209600
          }
        ],
        "subject": "string",
        "first_cold_outreach_uses_lead_created_at_for_waba_window": false
      },
      "started_at": "2024-07-29T15:51:28.071Z",
      "stopped_at": "2024-07-29T15:51:28.071Z"
    }