Memberships

Update Memberships

Replaces the Group's entire membership list with the given Actors.

Any Actor not named in the request is removed from the Group. To add or remove individual Actors without disturbing the rest, use PATCH.

Members that are not changing keep their membership rows, so a replace that leaves the list untouched is a no-op rather than a full rewrite.

Repeating an Actor in the request body is not an error; the list is deduplicated. actor_ids in the response is sorted, not returned in request order.

put/groups/{group_id}/memberships

Path parameters

group_idstring required

ID

Request body

Example request

{
  "memberships": [
    {
      "actor_id": "1234-1234"
    },
    {
      "actor_id": "2345-2345"
    }
  ]
}

Response

Membership Response

Example response

{
  "data": {
    "actor_ids": [
      "4ddfa557-7dfc-484f-894c-2024ec3fe9f7",
      "89d22f71-939d-442d-b148-897b730adfb4"
    ]
  }
}

Changes

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