Recipients

Update a recipient

Updates the profile, contacts and groups of a recipient. name is required on every call; every other field is optional and an omitted one is left as it is — including is_active, so renaming a disabled recipient does not re-enable them. contacts and groups are authoritative when present — anything missing from the list is removed. preferences is merged into the existing object rather than replacing it, and so is each contact metadata you do not send; its size, its nesting depth and its calls section are validated — see the field description in the request schema. The minimum interval between voice calls is NOT settable here (not even through preferences.calls): it has its own endpoint and its own floor. PATCH is accepted on the same path with identical semantics.

put/api/v1/recipients/{recipient}

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}
  • Auth: API key in header X-API-Key

Path parameters

recipientstring uuid required

Recipient UUID.

Request body

namestring required

Display name.

is_activeboolean

Whether the recipient may receive alerts. Omit it to leave the current state alone — renaming a disabled recipient does not re-enable them.

preferencesobject nullable

Free-form preferences, merged into the stored object rather than replacing it. Bounded in size and nesting depth (8 KiB / 6 levels by default) — an oversized object is rejected rather than stored. The calls section is NOT free-form: it holds the call policy this recipient is delivered under, and accepts exactly counted_outcomes (a non-empty list of answered | declined | no_answer | failed) and substitute_text (boolean). Any other key under calls is rejected, including call_min_interval_minutes — the interval lives elsewhere, has its own endpoint and a floor this route cannot lower.

groupsstring[] nullable

UUIDs of the recipient groups. Omit to leave group membership untouched, send [] to remove from every group.

Example request

{
  "contacts": [
    {
      "contact_type": "telegram"
    }
  ]
}

Response

Updated recipient.

Example response

{
  "data": {
    "contacts": [
      {
        "contact_type": "telegram"
      }
    ]
  }
}

Changes

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