API reference / Email
Add an email rule for every inbox
Allows or blocks an email address or a domain, with its subdomains, for every teammate's inbox: the mail that it gets (in), sends (out), or both. With an allow rule for a direction, only what an allow rule names goes through that way, for every teammate. Mail that the rules keep out is not kept. The same rule again changes nothing. Owners and admins only.
post
/api/v1/email/rulesOther ways to call it
CLI
troopy email-rules addMCP tool
troopy_add_email_ruleRate limit30 calls in 60 seconds, for each key
RetriesSend an
Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonkind*enum<string>allowblock
value*stringAn email address, or a domain like acme.com
At least 3 characters · At most 254 characters
directionenum<string>inoutboth
Default "both"
Response
200 · application/jsondata*object1 properties
rules*array<object>4 properties
id*stringA 24-character id
kind*enum<string>allowblock
value*stringAn email address, or a domain with its subdomains
direction*enum<string>in: mail that it gets. out: mail that it sends. both
inoutboth
Errors
400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.