Suppressions

Change contacts' status

Sets the status of up to 1,000 contacts (for example dnc or active). A contact who unsubscribed or whose address bounced is never set back to a status that can be emailed: it is counted in refused, listed in refused_ids and explained in message.

Required scope: prospects:write.

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

post/prospects/status

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/prospects/status
  • 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

prospect_idsstring[] required

Contact ids to change (1–1000).

status'active' | 'bounced' | 'invalid' | 'unsubscribed' | 'dnc' | 'suppressed' | 'risky' required

New status.

Response

Success

Changes

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