Actions

Call the getCampaignLeads MCP tool

Per-lead progress for ONE campaign: who accepted, replied, booked, failed (with fail_reason), or is still pending, plus each lead state. Use after getCampaigns (for the campaign_id) when the user asks how a campaign is doing lead by lead. Paginated with limit/offset; the response includes total. Aggregate numbers live in getCampaignStats and getCampaignFunnel.

Called through the Actions bridge: the response is that tool's own result, wrapped as { data: <tool result> } under HTTP 200. Billing, daily-cap, and confirm-step outcomes are embedded INSIDE data, never remapped to an HTTP status (see the templated /api/v1/actions/{toolName} operation above for the full protocol, and x-mcp-actions for this tool's machine-readable scope/cap/confirm_behavior fields). Authentication, request-shape, and optional idempotency-protocol failures still use their documented non-200 statuses.

post/api/v1/actions/getCampaignLeads

Request

  • Base URL: https://app.reachium.io
  • URL: https://app.reachium.io/api/v1/actions/getCampaignLeads
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional caller-generated key (8-200 characters: letters, digits, dot, underscore, colon, or hyphen). A final tool result is replayed for the same key and body. An ambiguous result remains 409 under that key; reconcile external state before using a new key. Reuse with a different body returns 422.

Request body

campaign_idstring uuid required

Campaign id from getCampaigns.

status'accepted' | 'replied' | 'booked' | 'pending_invite' | 'in_progress' | 'failed' | 'completed'

Optional filter: accepted | replied | booked | pending_invite | in_progress | failed | completed. Omit for all leads.

limitinteger

Rows per page (default 50, max 100).

offsetinteger

Pagination offset (default 0).

Response

The result of calling this tool.

dataunknown required
errorunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.