Skip to main content

Change project Signals settings

MethodPath
PATCH/v1/signals/settings

Shared authentication, project scope, and response conventions.

Changes settings only for the project's own Signals tenant. Send only the fields to change; other fields remain as they were. A project on a shared tenant cannot update settings here because the change would affect every project sharing it.

Body fieldAccepted valueAuthorization or effect
episodicAlertsBooleanProject admin plus signals_config:update. Turning it off while it is on disarms episodes and requires signals_silence:update and a non-empty reason.
synchronousModeBooleanSuper Admin only, as an operational setting.
throttleLimitInteger >= 0 or nullSuper Admin only. null restores the Signals default; 0 removes throttling. A change considered a reduction requires signals_silence:update and a reason. Because the Signals default is not known to Ovok, moving to or from null is treated as a reduction; a non-zero limit is also treated as a reduction from 0.
reasonOptional string, maximum 1,000 charactersRequired and non-empty for a disarming change; recorded with the audit event.

At least one setting field must be present. A request containing only reason is rejected. A person profile is also required for the audit record; a ClientApplication does not qualify.

curl --request PATCH \
--url 'https://api.sandbox.ovok.com/v1/signals/settings' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Content-Type: application/json' \
--data '{ "episodicAlerts": true }'

The response has the same shape as GET /v1/signals/settings, with the values Signals saved. Ovok records the before-and-after settings on the Project. If the audit write fails, Ovok attempts to restore the previous settings.

StatusMeaning
403Missing signals_config:update, not a project admin, missing person profile, or attempting a Super Admin-only change.
409 signals_shared_tenantThis project shares its Signals tenant and cannot change tenant-level settings.
409Another settings write for the project is in progress. Retry after it completes.
422No setting was supplied, an unknown field/value was sent, or a disarming change omitted its reason.
503 signals_audit_failedPrior settings were restored; retrying is safe.
503 signals_undo_failedThe change remains but could not be rolled back after audit failure; operator follow-up is required.
503 signals_unavailableSignals could not be reached or returned an unusable response.