Skip to main content

ManualSendingCampaignCreate

Payload to create a manual sending campaign. Returns 202 with a queued campaign; the worker does the sending.

product_idProduct Idrequired

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

name object

Optional human-readable name.

anyOf
string
source objectrequired

The message content to send to each targeted lead.

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
filter objectrequired

The lead filter selecting recipients.

product_idProduct Idrequired

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

id object

Match a single lead by id.

anyOf
integer
lead_idsinteger[]

Match a specific set of lead ids.

stage_idsinteger[]

Match leads in any of these stages.

name object

Match by lead name.

anyOf
string
crm_id object

Identifier of the matching record in the connected external CRM, if any.

anyOf
string
is_active object

Match by active flag.

anyOf
boolean
is_test object

Match by test flag.

anyOf
boolean
batch_name object

Match by import batch name.

anyOf
string
tag_idsinteger[]

Match leads having any of these tags.

contact object

Match by a contact value.

anyOf
string
crm_fields_conditions object

Composite CRM-field conditions (AND/OR with per-field operators).

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
  • ]
    • split object

    Whether to split long messages into parts.

    anyOf
    boolean
    planned_start_at object

    Defer the campaign start until this time (UTC); past/null starts it now. Editable while still queued.

    anyOf
    date-time
    daily_limit object

    Maximum number of leads scheduled per day (product/agent timezone); null = no daily cap.

    anyOf
    integer

    Possible values: >= 1

    activate_leadsActivate Leads

    When true, reactivate the lead and unmute its dialogue at send time instead of skipping muted/inactive ones.

    Default value: false
    activated_leads_grace_period_hoursActivated Leads Grace Period Hours

    Reply window, in hours, granted to reactivated leads after this campaign successfully schedules at least one message. Set to 0 to reactivate without suppressing stale-lead expiry.

    Possible values: >= 0

    Default value: 72
    daily_send_from object

    Local time of day (product/agent timezone) before which leads are not sent each day; null = from midnight.

    anyOf
    time
    daily_send_until object

    Local time of day (product/agent timezone) after which leads are not sent each day; null = until end of day.

    anyOf
    time
    ManualSendingCampaignCreate
    {
      "product_id": 0,
      "name": "string",
      "source": {
        "text": "string",
        "prompt_id": 0,
        "prompt_version_id": 0,
        "prepared_message_id": 0,
        "waba_template_id": 0,
        "file_ids": [
          0
        ],
        "caption": "string"
      },
      "filter": {
        "product_id": 0,
        "id": 0,
        "lead_ids": [
          0
        ],
        "stage_ids": [
          0
        ],
        "name": "string",
        "crm_id": "string",
        "is_active": true,
        "is_test": true,
        "batch_name": "string",
        "tag_ids": [
          0
        ],
        "contact": "string",
        "crm_fields_conditions": {
          "operator": "AND",
          "conditions": [
            {
              "field": "string",
              "operator": "EQUALS"
            }
          ]
        }
      },
      "split": true,
      "planned_start_at": "2024-07-29T15:51:28.071Z",
      "daily_limit": 0,
      "activate_leads": false,
      "activated_leads_grace_period_hours": 72,
      "daily_send_from": "string",
      "daily_send_until": "string"
    }