Settings
Tenant settings: redirect URIs, tracking defaults, retention, AI and the MCP send policy.
Guides: Redirect URIs, MCP send policy.
| Method | Path | Operation | Scope |
|---|---|---|---|
GET | /v1/settings | Get tenant settings | read |
PATCH | /v1/settings | Update tenant settings | admin |
Runs in your browser against api.workwae.com with the key you enter. Use a read-only key, limited to a test account if you can.
Required scope: read.
OK
application/json- response
bodyStorage*BodyStorage"none""cache""full"syncWindowDays*|nullcalendarEnabled*booleancontactsEnabled*booleanundoSendSeconds*integer0 <= value <= 60trackOpens*booleantrackClicks*booleantrackingHoneypot*booleanoptOutHandling*OptOutHandling"off""review""suppress"eventRetentionDays*integer7 <= value <= 30redirectUris*array<>items <= 50aiReplyClassification*booleanmcpSendPolicy*curl -X GET 'https://api.workwae.com/v1/settings'{ "bodyStorage": "none", "syncWindowDays": 1, "calendarEnabled": true, "contactsEnabled": true, "undoSendSeconds": 0, "trackOpens": true, "trackClicks": true, "trackingHoneypot": true, "optOutHandling": "off", "eventRetentionDays": 7, "redirectUris": [ "https://app.example.com/mail/connected" ], "aiReplyClassification": true, "mcpSendPolicy": { "mode": "allow", "allowedRecipientDomains": [ "string" ], "dailySendLimit": 1, "externalRecipientConfirmation": true }}Runs against the live API with the key you enter: this change really happens. Use a key limited to a test account.
bodyStorage applies to every account without its own override; changing it restarts their syncs (full stores and backfills every indexed message, none deletes stored content). mcpSendPolicy limits what agents send through the MCP server only (/v1 sends are not held to it); its keys present change, absent ones stay. Requires the admin scope.
Required scope: admin.
application/json- body
bodyStorage?BodyStorage"none""cache""full"syncWindowDays?|nullcalendarEnabled?booleancontactsEnabled?booleanundoSendSeconds?integer0 <= value <= 60trackOpens?booleantrackClicks?booleantrackingHoneypot?booleanoptOutHandling?OptOutHandling"off""review""suppress"eventRetentionDays?integer7 <= value <= 30redirectUris?array<>items <= 50aiReplyClassification?booleanmcpSendPolicy?OK
application/json- response
bodyStorage*BodyStorage"none""cache""full"syncWindowDays*|nullcalendarEnabled*booleancontactsEnabled*booleanundoSendSeconds*integer0 <= value <= 60trackOpens*booleantrackClicks*booleantrackingHoneypot*booleanoptOutHandling*OptOutHandling"off""review""suppress"eventRetentionDays*integer7 <= value <= 30redirectUris*array<>items <= 50aiReplyClassification*booleanmcpSendPolicy*curl -X PATCH 'https://api.workwae.com/v1/settings' \ -H 'Content-Type: application/json' \ -d '{}'{ "bodyStorage": "none", "syncWindowDays": 1, "calendarEnabled": true, "contactsEnabled": true, "undoSendSeconds": 0, "trackOpens": true, "trackClicks": true, "trackingHoneypot": true, "optOutHandling": "off", "eventRetentionDays": 7, "redirectUris": [ "https://app.example.com/mail/connected" ], "aiReplyClassification": true, "mcpSendPolicy": { "mode": "allow", "allowedRecipientDomains": [ "string" ], "dailySendLimit": 1, "externalRecipientConfirmation": true }}