Suppress an opted-out recipient

Block future agent Business template sends and campaign claims for one phone number. Use when a person opts out. Suppression persists across campaigns and cannot recall a message already in flight.

post/api/v1/tools/suppress_recipient

Request

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

phoneNumberstring required
reasonstring 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.