Update site settings
Update site-wide settings. Requires staff access.
Endpoint
PUT /api/v1/site-settingsAuthenticated Staff only
Request body
Provide only the fields you want to change. Omitted fields keep their current values.
{ "signups_enabled": true, "signups_require_invite": true, "signup_invite_min_account_age": "1w", "signup_invite_max_per_24h": 3, "signup_invite_creators": "staff" }Usage
curl -X PUT \
--header "Authorization: Bearer $PEARING_API_TOKEN" \
--header "Content-Type: application/json" \
--data '{"signups_enabled": true, "signups_require_invite": true, "signup_invite_min_account_age": "1w", "signup_invite_max_per_24h": 3, "signup_invite_creators": "staff"}' \
"$PEARING_API_URL/v1/site-settings"Success
200 OK with updated settings.
{ "signups_enabled": true, "signups_require_invite": true, "signup_invite_min_account_age": "1w", "signup_invite_max_per_24h": 3, "signup_invite_creators": "staff" }Errors
403 Forbidden if the authenticated user is not staff.