API reference / Troop
Send an email from a teammate
Sends one email now from a teammate's own address, with its signature, to one address or to up to 10 addresses. A teammate sends only from its own address, after an owner or admin says yes. A person who sends must be an owner or admin. Troopy refuses a paused inbox, an address on do-not-contact, and an email for more addresses than the daily cap has left for 24 hours. The answer is the kept email: sent, failed with the reason, or unknown when it possibly went. Troopy does not send an unknown email again.
/api/v1/agents/{handle}/inbox/sendOther ways to call it
troopy agents send-emailIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
handle*stringThe teammate's handle, like chief
At most 40 characters
Body
application/jsonto*string | array<string>One email address, or a list of up to 10 addresses
subjectstringNeeded, except for an answer: an answer takes the subject of its email
At most 300 characters
body*stringPlain text. The signature goes under it
At least 1 characters · At most 20000 characters
replyTostringThe id of an email in this teammate's inbox that it answers
Response
201 · application/jsondata*object14 properties
id*stringA 24-character id
direction*enum<string>in for an email that came, out for one that the address sent
inout
from*stringThe sender's address
fromName*stringsubject*stringCodes in it masked, like [code 1]
receivedAt*stringISO 8601 date and time
checked*booleanThe sender's domain passed DMARC: the one sign it is who it says
spam*booleanSES called it spam: the teammate doesn't see it
codes*integerHow many codes it carries. Never shown over the API: the teammate types them by reference
links*array<object>Its links' sites and words, never their addresses
3 properties
n*integersite*stringlabel*stringto*array<string>A sent email: the addresses that it went to
status*enum<string> | nullA sent email: whether it went. unknown when it possibly went: Troopy does not send it again
sendingsentfailedunknown
error*string | nullA sent email that did not go, or possibly did not: why
textstringOne email's words, every code and link masked