Recipient groups

Create a recipient group

Creates a group and, optionally, fills it in one call. Repeating the call with a name that already exists returns the existing group with 200 instead of creating a duplicate; the members of that existing group are left exactly as they are, so use the update endpoint when you mean to change them. One caveat for retries: the plan's group limit is checked before that name lookup, so retrying a create that already succeeded and filled the last free slot answers 429 rather than 200 — treat a 429 on a retry as "probably already created" and check the listing.

post/api/v1/recipient-groups

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
  • Auth: API key in header X-API-Key

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

A group with this name already existed and was returned unchanged.

Changes

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