RecipientPatch

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/uptimemonitoring-com/json-schema/uptimemonitoring-com-recipient-patch-schema.json",
  "title": "RecipientPatch",
  "description": "Every field is optional; only fields present are changed. `type`\nmust not be present at all. `name`/`default`/`events`/`config`\neach reject an explicit JSON `null`. Changing `config.address` on\na `type=email` recipient resets it to `status:\"pending\"` (old\nconfirm/unsubscribe links stop working, a new confirmation is\nsent) and records `recipient.updated` with\n`changes.address: {\"changed\": true}` — never the old or new\naddress itself. For `type=slack` (issue #359), `config.url` and\n`config.channel` are each independently optional — at least one\nis required when `config` is present — and changing either\nrecords `changes.url: {\"changed\": true}` (never the URL text) and\n`changes.channel: {\"old\": ..., \"new\": ...}` respectively, and\ncancels the recipient's own still-queued deliveries. Setting\n`config.channel` to `null` or `\"\"` clears the override. For\n`type=pagerduty` (issue #363), `config.integration_key` is\nrequired when `config` is present; changing it records\n`changes.integration_key: {\"changed\": true}` (never the key\nitself) and cancels the recipient's own still-queued deliveries —\nit does not resolve an incident the old key already opened in\nPagerDuty.\n",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/uptimemonitoring-com-openapi.yaml#/components/schemas/RecipientPatch",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "config": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "maxLength": 2048
        },
        "address": {
          "type": "string",
          "format": "email"
        },
        "channel": {
          "type": [
            "string",
            "null"
          ],
          "description": "`type=slack` only. `null` or `\"\"` clears the channel\noverride back to the incoming webhook's own default.\n"
        },
        "integration_key": {
          "type": "string",
          "description": "`type=pagerduty` only. Exactly 32 characters of\n`[A-Za-z0-9]`.\n"
        }
      }
    },
    "default": {
      "type": "boolean"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "down",
          "up",
          "flapping"
        ]
      },
      "minItems": 1
    }
  }
}