Team Management

Remove Group Member Access

Changed on

Removes a user's direct group membership and their explicit website memberships for websites currently in the group. Both sets of rows are removed atomically. The request is idempotent: a retry, or a well-formed user ID with no matching membership rows, returns 200 with group_membership_removed: false and website_memberships_removed: 0.

Organization membership, membership in other groups, and website membership outside this group are preserved. If another group grants access to one of the same websites, that effective access remains through the other group even though the user's explicit website membership row is removed. Organization members return 409 because their organization-derived access would remain. Requires a global API key, and the API key's own user cannot be removed. The endpoint accepts no request body.

delete/api/v1/groups/{group_id}/members/{user_id}

Request

  • Base URL
    https://api.athenahq.ai
  • Auth
    API key in header x-api-key

Response

Group-scoped membership removal completed

successtrue required
group_membership_removedboolean required

Whether a direct group membership row was removed

website_memberships_removedinteger required

Number of explicit website membership rows removed for websites currently in the group

Example response

{
  "success": true,
  "group_membership_removed": true,
  "website_memberships_removed": 3
}

Changes