Recipient groups

Update a recipient group (PATCH alias)

Identical to PUT on the same path. name stays required either way, and recipients stays authoritative whenever you send it — the list you send becomes the membership, and anyone missing from it leaves the group. The verb does not make it additive. Omit the field to leave membership alone. description, by contrast, really is partial: omitted keeps it, explicit null erases it.

patch/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.