API reference / Troop
Get a teammate's email settings
A teammate's own address, its signature, its daily cap, whether it is paused, and how many emails it sent in the last 24 hours.
/api/v1/agents/{handle}/inbox/settingsOther ways to call it
troopy agents email-settingstroopy_get_teammate_email_settingsPath parameters
handle*stringThe teammate's handle, like chief
At most 40 characters
Response
200 · application/jsondata*object13 properties
handle*stringThe teammate's handle, like chief
At most 40 characters
name*stringbox*stringIts box in GET /emails: a t- id
address*stringThe teammate's own email address
fromName*stringThe name that people see beside the address. Empty: the teammate's name
signature*stringGoes under every email that the address sends
dailyCap*integerThe most emails that the address sends in 24 hours. Each address of an email counts as one
paused*booleanA paused inbox still takes mail, but the teammate neither reads it nor sends from it
wake*enum<string>Which new mail starts the teammate on it, as a task. people: the people of the workspace, the addresses that it wrote to, and answers to its mail. anyone: every sender that passed DMARC too. off: none
offpeopleanyone
instructions*stringHow the teammate handles the mail of this address, beside the Email file of the workspace
rules*array<object>Who the address takes mail from and sends to. A block wins. With an allow rule for a direction, only what it allows goes through. The rules of the workspace (GET /email/rules) apply too
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
deleted*booleanA person deleted the inbox: the address takes no mail. POST /agents/{handle}/inbox gives a new one
sentToday*integerEmails that it sent in the last 24 hours, each address one