GET/POST · Bearer

GET/POST /api/v1/lists/:direction/:type

All endpoints · Markdown

Summary

Account-wide allow and block lists. direction is send, receive, or reply. type is allow or block. POST {entry, reason?} returns 201, or 200 when that entry already exists. An entry is a lowercase email or domain (at most 1000 per list). GET accepts limit (default 100, max 1000) and page_token. Bad direction or type is 400 invalid_list. A bad entry is 400 invalid_entry. A full list is 400 list_full. GET and DELETE /api/v1/lists/:direction/:type/:entry use a URL-encoded entry. A missing entry is 404 list_entry_not_found. The per-inbox allowlist (POST /api/v1/inboxes/:id/allowlist) only marks senders who can open a task; allow and block lists decide which addresses may be sent to or accepted as mail. When an inbox has any entries for a direction, only that inbox's lists apply. A block match wins. A non-empty allow list blocks everyone else. Progress email to a verified owner is exempt.

Request

{
  "entry": "ada@example.com",
  "reason": "customer"
}

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

  • HTTP 400 invalid_list
  • HTTP 400 invalid_entry
  • HTTP 400 list_full
  • HTTP 404 list_entry_not_found

Idempotency

This route does not document Idempotency-Key or client_id.