v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB
Recipients

Update a Recipient

Update a Recipient by specifying the recipient ID and full recipient details. (Partial PUT is not supported.) Updates to the Recipient Type is not supported. For example, changing an existing Recipient from PagerDuty to Email is not allowed. Important: Modifying an existing recipient will change the destination of all triggers/burn alerts that use that recipient.

put/1/recipients/{recipientId}

Request body

OR
OR
OR
OR
OR

Example request

{
  "id": "yUheCUmgZ8p",
  "created_at": "2022-07-26T22:38:04Z",
  "updated_at": "2022-07-26T22:38:04Z",
  "details": {
    "pagerduty_integration_name": "Example PagerDuty Service",
    "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
  }
}

Response

Success

OR
OR
OR
OR
OR

Example response

{
  "id": "yUheCUmgZ8p",
  "created_at": "2022-07-26T22:38:04Z",
  "updated_at": "2022-07-26T22:38:04Z",
  "details": {
    "pagerduty_integration_name": "Example PagerDuty Service",
    "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
  }
}