PATCH
https://app.evoriqa.com/api/v1/workspace/digest-settingsToggle the weekly digest
Turns the weekly outcomes email digest on or off for the workspace owner. Mirrors the dashboard toggle and is audited identically; a bad body is 422.
Requires scope workspace:write
Warning:
Access is gated — enable it before your first call
The API is off by default. A request succeeds only when all three switches are on: the platform master switch (off by default), your organisation’s API toggle, and your plan or client entitlement. Any one off returns 403 API access is not enabled for this workspace.
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
| weeklyDigestEnabled | boolean | Required | Whether the weekly digest is sent. |
Request
curl
curl -X PATCH "https://app.evoriqa.com/api/v1/workspace/digest-settings" \
-H "x-api-key: $EVORIQA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "weeklyDigestEnabled": true }'Node.js
const res = await fetch("https://app.evoriqa.com/api/v1/workspace/digest-settings", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.EVORIQA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"weeklyDigestEnabled": true
}),
});
const responseBody = await res.json();Python
import os
import requests
res = requests.patch(
"https://app.evoriqa.com/api/v1/workspace/digest-settings",
headers={"Authorization": f"Bearer {os.environ['EVORIQA_API_KEY']}"},
json={
"weeklyDigestEnabled": True
},
)
body = res.json()Response
200 OK
{
"success": true,
"data": {
"weeklyDigestEnabled": true
}
}