Recipient groups

Update a recipient group

Updates the name, the description and the membership of a group. recipients is authoritative when present — anyone missing from the list is removed from the group — and untouched when the field is omitted entirely. description is left alone when omitted and erased by an explicit null; you do not have to echo it back to keep it. Removing someone from a group never deletes the recipient. PATCH is accepted on the same path with identical semantics.

put/api/v1/recipient-groups/{group}

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/recipient-groups/{group}
  • Auth: API key in header X-API-Key

Path parameters

groupstring uuid required

Group UUID.

Request body

namestring required

Display name.

descriptionstring nullable

Free text for people, never used to route anything. Omitting the field on an update leaves the stored text alone; sending an explicit null erases it. This is the one field here that behaves that way — recipients is authoritative, not sparse.

recipientsstring[] nullable

Full member list, by recipient UUID. Omit to leave membership untouched, send [] to empty the group; anyone missing from a non-empty list is removed. UUIDs belonging to another company are silently ignored.

Response

Updated group.

Changes

No recorded changes to this operation across all 1 revision of this API.