Skip to content

Invitation Exclusions Guide ​

The historical /blacklist/emails path is retained for compatibility. It now has a deliberately restricted compliance contract: integrations can read active invitation exclusions and record one recipient's express opt-out. It is not a tool for selecting who may review.

Endpoints ​

MethodPathPurpose
GET/api/2026-04/blacklist/emailsRead active invitation exclusions, including compatible legacy email/domain rows.
POST/api/2026-04/blacklist/emailsRecord one recipient's express opt-out.
DELETE/api/2026-04/blacklist/emailsAlways rejected with 409; a business cannot revoke an opt-out.

Record a recipient opt-out ​

bash
curl "https://api.revi.io/api/2026-04/blacklist/emails" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: revi_test_xxxxxxxxx" \
  -d '{"type":"email","value":"buyer@example.com","reason_code":"recipient_optout","attestation":true}'

The email must belong to a recipient related to the authenticated business and contain at most 50 characters. attestation: true confirms that this recipient expressly asked not to receive invitations. One exact email is accepted per request. Domains, patterns, arrays, bulk operations and exclusions based on a complaint, return, incident or expected rating are rejected. Repeating the same valid request is idempotent.

List exclusions ​

bash
curl "https://api.revi.io/api/2026-04/blacklist/emails?type=email&per_page=25" \
  -H "Accept: application/json" \
  -H "X-API-KEY: revi_test_xxxxxxxxx"

Supported filters are page, per_page (1–100), type (email or domain) and query. Revoked suppressions are omitted. A domain row may still appear when it comes from the legacy system, but domains cannot be created through this public endpoint.

Revocation ​

DELETE returns 409 recipient_optout_revocation_requires_review without changing data or requeueing invitations. Revocation requires documented renewed consent from the recipient and Support review.

Public API documentation for Revi.