List campaign recipients
list_whatsapp_campaign_recipientsList campaign recipients. The campaign's recipients in the order they were added, with their delivery state. Paginated: 100 per page by default, at most 500. Recipients exist once the campaign has been materialized or a CSV has been imported. To follow delivery and replies from another system, pass updated_since and then each response's meta.next_cursor as cursor until it is null: you get every recipient whose state changed, oldest change first. replied=true keeps only the recipients who answered; conversation_display_id opens their conversation. Administrators only. Requires feature: whatsapp_campaigns.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"id": "<id>"
},
"name": "list_whatsapp_campaign_recipients"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ID of the campaign | |
| page | No | Page number, from 1. | |
| cursor | No | Sync mode. The `meta.next_cursor` from the previous response. | |
| fields | No | Optional: return only these fields of each record. | |
| replied | No | `true` for only the recipients who replied. | |
| stage__ | No | Only recipients whose reply is in these lead stages (campaign reply qualification). `unscored` also matches replies not assessed yet. Unknown values are ignored. | |
| per_page | No | Recipients per page. Values above 500 are capped at 500. | |
| status__ | No | Only recipients in these statuses. Unknown values are ignored. | |
| updated_since | No | Sync mode. Only recipients created or changed at or after this ISO 8601 timestamp, oldest change first. |