/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Update Ownership Settings

Update Ownership Settings

Set when an owned page counts as stale and where stale-page alerts should go.

PATCH/v1/projects/{projectId}/ownership/settingsTry it
Session token

Set how many days without a change make an owned page stale, and where stale-page alerts should be delivered. Send only the settings you want to change; the response is the full set.

Note

Requires the admin or owner role, signed in with a session JWT — API keys are refused with 401. A member gets 403 forbidden with details.requiredRole: "admin" and details.currentRole — see Role errors. You must belong to the organization that owns {projectId}. Available on every plan.

staleAfterDays drives the stale count in the ownership summary and the weekly alerts. Every Monday at 09:00 UTC, with emailWeekly on, each owner gets one email of their stale pages; with postToSlack on and a slackChannel set, the channel gets one message through the project's Slack bot (invite the bot to a private channel first). A page is alerted once per stale period, and again after it's edited and goes stale again, or when staleAfterDays changes. See Stale-page alerts.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Request Body

Send at least one field.

NameDescription
staleAfterDays:integerbody
Days without a change after which an owned page is stale, 1–3650.
Default90
emailWeekly:booleanbody
Send owners a weekly email of their stale pages.
Defaultfalse
slackChannel:string | nullbody
Channel name, e.g. #docs — letters, digits, _, . and -, with an optional leading #, up to 80 characters. null clears it.
Default"null"
postToSlack:booleanbody
Post stale pages to slackChannel.
Defaultfalse

Response — 200 OK

The change is recorded in the audit log as ownership_alerts.update. Other project settings are left untouched.

Error Responses

400 Bad Request

The body failed schema validation — it was empty, staleAfterDays was out of range, or slackChannel had spaces or other characters. The code is validation_error, with each problem in details.issues.

401 Unauthorized

No session JWT, an expired one, or an API key.

403 Forbidden

forbidden — your role is below admin (details.requiredRole, details.currentRole), or you are not a member of the organization that owns the project.

404 Not Found

not_found — the project does not exist or was deleted.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X PATCH https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/ownership/settings \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
-H "Content-Type: application/json" \
-d '{
"staleAfterDays": 30,
"slackChannel": "#docs-maintainers",
"postToSlack": true
}'
Responseapplication/json
200OK
{
"data": {
"staleAfterDays": 30,
"emailWeekly": false,
"slackChannel": "#docs-maintainers",
"postToSlack": true
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext