Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Change what Troopy tells you about

Turns the bell or the email of some events on or off, for you, in every workspace. An event that Troopy sends no email for stays without one. The events that you leave out stay as they are.

patch/api/v1/me/notification-settings

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy notifications set
MCP toolNone. Call it over REST or with the CLI.
Rate limit60 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/json
events*array<object>

At most 13 items

3 properties
kind*enum<string>

decisionreviewtaskdraftreplymailroutine_doneroutine_failedweeklyremindersessionmentionvisitor

appboolean
emailboolean

Response

200 · application/json
data*array<object>
5 properties
kind*enum<string>

decisionreviewtaskdraftreplymailroutine_doneroutine_failedweeklyremindersessionmentionvisitor

title*string
line*string

What the event is, in one line

app*boolean

It shows in the bell of the app

email*boolean | null

It goes to you by email. Null: Troopy sends no email for this event

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.