Suppressions

Suppress prospects by email

Adds emails to your suppression list so those people are never contacted by any campaign. Existing prospects are marked suppressed.

Required scope: suppressions:write.

Requires a unique Idempotency-Key request header so retries never duplicate.

post/prospects/suppress

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/prospects/suppress
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

A unique key (e.g. a UUID) that makes this write safe to retry. Reusing a key returns the original result; reusing it with a different body returns 409.

Request body

emailsstring[] required

Emails to suppress (1–1000).

reasonstring

Optional reason stored with each entry.

Response

Success

Changes

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