Skip to the page

Set notification preferences

PUT/v1/organisations/{id}/notification-preferences

Operation notifications.setPreferences · since 2026-11-05 · stable

Needs a session withwritescopeAnswers200 OK

Path parameters

idstring (uuid)required
The organisation id.

Body (JSON)

preferencesarray of { kind, inConsole, email }required
Up to 20 kinds per call, like environment.failed, approval.waiting, budget.threshold or build.failed.

Errors

Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer.

PUT/v1/organisations/{id}/notification-preferences
curl -X PUT "https://api.rykloud.com/v1/organisations/$ORG_ID/notification-preferences" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "preferences": [
    {
      "kind": "environment.failed",
      "inConsole": true,
      "email": true
    }
  ]
}'