PaginatedResponse[ManualSendingCampaignRead]
items object[]required
Unique numeric identifier of the record.
ID of the product (workspace) that owns this record. Most endpoints scope access by product.
created_by_user_id object
ID of the user who created the campaign.
- integer
- null
Human-readable campaign name.
source objectrequired
The message content to send to each targeted lead.
text object
- string
- null
prompt_id object
- integer
- null
prompt_version_id object
- integer
- null
prepared_message_id object
- integer
- null
waba_template_id object
- integer
- null
caption object
- string
- null
filter_config objectrequired
The lead filter used to select recipients.
ID of the product (workspace) that owns this record. Most endpoints scope access by product.
id object
Match a single lead by id.
- integer
- null
Match a specific set of lead ids.
Match leads in any of these stages.
name object
Match by lead name.
- string
- null
crm_id object
Identifier of the matching record in the connected external CRM, if any.
- string
- null
is_active object
Match by active flag.
- boolean
- null
is_test object
Match by test flag.
- boolean
- null
batch_name object
Match by import batch name.
- string
- null
Match leads having any of these tags.
contact object
Match by a contact value.
- string
- null
crm_fields_conditions object
Composite CRM-field conditions (AND/OR with per-field operators).
- CRMFieldsConditionsConfig
- null
Possible values: [AND, OR]
ANDconditions object[]
Possible values: [EQUALS, NOT_EQUALS, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, EXISTS, NOT_EXISTS, IS_EMPTY, IS_NOT_EMPTY]
split object
Whether to split long messages into parts.
- boolean
- null
planned_start_at object
Defer the campaign start until this time (UTC). While unset/past the campaign starts on the next worker tick; until it starts it stays editable.
- date-time
- null
daily_limit object
Maximum number of leads scheduled per day (product/agent timezone); null = no daily cap.
- integer
- null
When true, reactivate the lead and unmute its dialogue at send time instead of skipping muted/inactive ones.
falseReply window, in hours, granted to reactivated leads after this campaign successfully schedules at least one message. During this window stale-lead expiry is suppressed. Set to 0 to reactivate without granting a grace window.
72daily_send_from object
Local time of day (product/agent timezone) before which leads are not sent each day; null = from midnight.
- time
- null
daily_send_until object
Local time of day (product/agent timezone) after which leads are not sent each day; null = until end of day.
- time
- null
next_eligible_at object
Read-only. When a campaign is paused (daily limit spent or outside the send window), the time it next becomes eligible to advance (UTC); null otherwise.
- date-time
- null
Lifecycle status — queued, running, completed, failed, or cancelled.
Possible values: [queued, running, completed, failed, cancelled]
error object
Failure detail if the campaign failed.
- string
- null
started_at object
When processing started (UTC).
- date-time
- null
finished_at object
When processing finished (UTC).
- date-time
- null
Creation time (UTC, ISO 8601).
Last modification time (UTC, ISO 8601).
stats object
Aggregate counters for the campaign.
Distinct leads snapshotted as targets (canonical campaign size).
0Number of targeted dialogues that received a reply.
0Total inbound messages received in targeted dialogues.
0Total messages created by the campaign.
0Messages that failed to send.
0Messages scheduled but not yet sent.
0Messages cancelled before sending.
0Messages sent.
0Messages delivered.
0{
"items": [
{
"id": 0,
"product_id": 0,
"created_by_user_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_config": {
"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",
"next_eligible_at": "2024-07-29T15:51:28.071Z",
"status": "queued",
"error": "string",
"started_at": "2024-07-29T15:51:28.071Z",
"finished_at": "2024-07-29T15:51:28.071Z",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"stats": {
"target_leads_count": 0,
"dialogues_with_responses_count": 0,
"messages_received_total": 0,
"messages_created_total": 0,
"messages_failed_total": 0,
"messages_scheduled_total": 0,
"messages_cancelled_total": 0,
"messages_sent_total": 0,
"messages_delivered_total": 0
}
}
],
"page": 0,
"limit": 0,
"total": 0,
"pages": 0
}