API reference / Troop
Change a teammate's email settings
Changes a teammate's own address, its sender name, its signature, its daily cap, which new mail starts it, its handling notes, or pauses it. The address is the part before the @, 3 to 40 letters, digits, dots or hyphens. An address is taken when any teammate has it or had it. The old address still takes mail, so the accounts that the teammate opened with it still reach it. A teammate changes its address at most 5 times. A paused inbox still takes mail, but the teammate neither reads it nor sends from it. Owners and admins only.
/api/v1/agents/{handle}/inboxOther ways to call it
troopy agents addresstroopy_update_teammate_addressIdempotency-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/jsonaddressstringThe part before the @
At least 3 characters · At most 40 characters
fromNamestringThe name that people see beside the address, one line without an @. Empty for the teammate's name
At most 80 characters
signaturestringGoes under every email that the address sends. Empty for none
At most 1000 characters
dailyCapintegerThe most emails that it sends in 24 hours
At least 1 · At most 100
pausedbooleanwakeenum<string>Which new mail starts the teammate on it
offpeopleanyone
instructionsstringHow it handles the mail of this address. Empty for none
At most 4000 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