Memberships

Update an Membership

Adds and/or removes individual Actors, leaving every other member of the Group untouched.

Both operations are idempotent: adding an Actor already in the Group and removing one that isn't are both no-ops. remove is applied before add, so an Actor named in both ends up in the Group. Retrying a request that may already have been applied is therefore safe.

Repeating an Actor within add or remove is not an error; both lists are deduplicated. actor_ids in the response is sorted.

patch/groups/{group_id}/memberships

Path parameters

group_idstring required

ID

Request body

Example request

{
  "memberships": {
    "add": [
      "1234-1234"
    ],
    "remove": [
      "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.