Inspect campaign recipient outcomes

Read a bounded page of recipient outcomes and provider message IDs. Pending, sending, accepted, failed, unknown and suppressed are distinct; never automatically retry uncertain recipients.

post/api/v1/tools/list_campaign_recipients

Request

  • Base URL: https://whatsync.app
  • URL: https://whatsync.app/api/v1/tools/list_campaign_recipients
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring

Stable key for a write; body idempotencyKey takes precedence.

Request body

campaignIdstring uuid required
afterstring uuid
limitinteger
status'pending' | 'sending' | 'accepted' | 'failed' | 'unknown' | 'suppressed'

Response

JSON result. Every response includes X-Request-Id.

object required

Changes

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