Start a Business campaign

Start real Business template sends to a draft campaign's opted-in recipients. Requires an enabled worker and both campaign and send permissions. Inspect the exact template, audience count and estimated charges with the user first.

post/api/v1/tools/start_campaign

Request

  • Base URL: https://whatsync.app
  • URL: https://whatsync.app/api/v1/tools/start_campaign
  • 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

idempotencyKeystring required

Unique key for this intended action. Reuse exactly on retries; use a new key only for a new action.

campaignIdstring uuid required

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.