Recipients

Update a recipient (PATCH alias)

Identical to PUT on the same path, including the parts that are not partial. Every field except name may be omitted and an omitted one is left untouched — but contacts and groups are authoritative whenever you send them: a list is the new whole truth, and anything missing from it is deleted. The verb changes nothing about that. Sending contacts with the one entry you meant to edit removes every other contact the person had, which on this endpoint means removing the ways to reach them. To change one contact, use the per-contact endpoints under /recipients/{recipient}/contacts instead of resending the list.

patch/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.