v1

latestOpenAPI 3.0.02026-08-0650184174.6 KB

Contacts

Update a contact

Update a contact with at least one contact method (notification target)

put/alerting/contacts/{contactid}

Path parameters

contactidinteger required

ID of contact to be updated

Request body

namestring required

Contact name

pausedtrue | false required

Pause contact

Example request

{
  "name": "John Doe",
  "paused": false,
  "notification_targets": {
    "email": [
      {
        "severity": "HIGH",
        "address": "johndoe@teamrocket.com"
      }
    ],
    "sms": [
      {
        "severity": "HIGH",
        "country_code": "93",
        "number": "111111111",
        "provider": "provider's name"
      }
    ]
  }
}

Response

Successful operation

Example response

{
  "contact": {
    "id": 123456,
    "name": "John Doe",
    "paused": false,
    "type": "user",
    "owner": true,
    "notification_targets": {
      "email": [
        {
          "severity": "HIGH",
          "address": "johndoe@teamrocket.com"
        }
      ],
      "sms": [
        {
          "severity": "HIGH",
          "country_code": "00",
          "number": "111111111",
          "provider": "provider's name"
        }
      ]
    },
    "teams": [
      {
        "id": 123456,
        "name": "The Dream Team"
      }
    ]
  }
}