Notification settings

Create or update the notification rule of one priority

Creates the rule if this priority had none and updates it otherwise, so repeating the call after a timeout is safe and never produces a second rule. Only the fields present in the body are written; everything omitted keeps its stored value, which makes it safe to change one escalation chain without restating the quiet hours. The priority comes from the path — a priority in the body is ignored, so a rule cannot land on the wrong one. Sending an empty escalation_rules list does not switch escalation off: a saved rule with no steps still inherits the account-wide default steps. PATCH is accepted on the same path with identical semantics.

put/api/v1/recipients/{recipient}/notification-settings/{priority}

Request

  • Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
  • URL: https://wardenpoint.com/api/v1/recipients/{recipient}/notification-settings/{priority}
  • Auth: API key in header X-API-Key

Path parameters

recipientstring uuid required

Recipient UUID.

priority'low' | 'normal' | 'high' | 'critical' required

Alert priority the rule applies to.

Request body

escalation_policy_uuidstring uuid nullable

Point this rule at a reusable policy. Send null to detach and fall back to the inline steps.

schedule_gridobject nullable

Allowed delivery hours as {weekday "0".."6": [hours 0..23]}. A complete 7x24 grid is stored as "round the clock".

quiet_hours_startinteger nullable

Hour the quiet window opens, on the platform clock. Null (the default) means no quiet hours and nothing on this priority is ever held back for the time of day.

quiet_hours_endinteger nullable

Hour the quiet window closes. Required whenever quiet_hours_start is sent. May be smaller than the start — the window then crosses midnight, which is the usual shape (22 to 7).

bypass_quiet_hours_criticalboolean

Let critical alerts through the quiet window. Only critical — the other three priorities wait until the window closes however this is set. Default true, so setting a quiet window does not by itself silence the page you would want to be woken for.

min_interval_minutesinteger

Smallest gap between two alerts to this person, in minutes. Default 0, meaning no gap.

The gap is measured against their last completed delivery on any priority, not just this one: the number is read from the rule of the priority being sent, but the clock it compares against is shared by the whole person. A low rule with a 30-minute gap therefore also swallows a low alert that arrives ten minutes after a critical one.

max_daily_notificationsinteger nullable

Cap on deliveries to this person per calendar day. 0 (the default) or null means no cap.

Counted the same way the gap is measured — every completed delivery to this person that day, on any priority, test alerts excluded. Attempts that failed or were held back do not consume the quota; the day rolls over at midnight on the platform clock.

audio_source'tts' | 'file' nullable

What a voice channel says. tts or null (the default) synthesises the alert text. file plays a recording you uploaded, named by audio_file_uuid. Ignored by text channels.

file is a preference, not a guarantee: if the recording is missing or still converting, delivery falls through to the audio of the matching escalation step, and then to synthesised text. A voice alert is never dropped for want of a file.

audio_file_uuidstring uuid nullable

The recording to play. Required when audio_source is file, ignored otherwise. Must be a file of this company that finished converting.

Response

The stored rule.

Changes

No recorded changes to this operation across all 1 revision of this API.