Updating Recipient Group Details | LogicMonitor

Product Documentation

You can use LogicMonitor REST API v3 to update recipient group details. You must authenticate yourself before making the API request.

URI: PATCH /setting/recipientgroups/{id}

URI: PUT /setting/recipientgroups/{id}

Parameter	Type	Description
`id`	Integer	(Mandatory) The Id of the recipient group whose details you want to update.
`groupName`	String	(Mandatory) The name of the recipient group that you want to update. Example – `"groupName": "Tier 2 Helpdesk"`
`recipients`	JSON Array	A recipient is a user or email address that receives alerts for specific events. The field contains information of the recipients in the group. A recipient group has multiple alert delivery recipients. Because it contains multiple user accounts or other recipient groups, it becomes easy to notify a variety of alert types to recipients of the same group. The field contains the following information about the recipients: `type` – (Mandatory) Supported recipient types are `GROUP`, `ARBITRARY`, and `ADMIN`. Here, `ADMIN` indicates a user and `ARBITRARY` indicates an arbitrary email. `method` – (Mandatory) Supported methods are `EMAIL`, `smsEMAIL`, `VOICE`, `SMS`, and `LM integrations`. The method varies as per the recipient type. `ARBITRARY` – use `email`. `ADMIN` – use `EMAIL`, `smsEMAIL`, `VOICE`, `SMS`, or the `defaultMethod`. `GROUP` – does not require a `method`. `contact` – It includes the email address or phone number of the recipients. `addr` – If the `type` is `Admin` provide the username, and if the type is `Arbitrary` provide the email address of the recipients.
`description`	String	The description of the recipient group. Example – `"description": "Tier 2 Helpdesk"`