Skip to content
Docs
Open Escouade
Documentation contents

Docs › Mail › Tools

add_suppression

View as .md

Block an address or a domain.

Adds an address or a whole domain to the space’s block list: nothing more will be sent to them, and whatever was waiting to leave towards them is cancelled. Use it as soon as a correspondent asks not to be contacted again. A public mail service (gmail.com…) cannot be blocked as a whole. Lifting the block afterwards (remove_suppression) needs the approve permission: an agent without it cannot undo it alone.

Access

  • Key: an Escouade Mail key with send or approve.
  • Space: any space, verified or not.
  • Changes nothing: no, it acts.
  • Safe to replay: yes.

Parameters

ParameterTypeRequiredDescription
addressstringyesAn address ([email protected]) or a whole domain (@example.com).
notestringnoWhy, for the log.

Call it

Terminal
curl -s https://api.subagent.fr/v1/add_suppression \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sak_…' \
  -d '{"address": "…"}'

The full page in French, with the response fields and every refusal the tool can return: /mail/docs/reference/add_suppression.