splitwise_remove_user_from_group
Remove a member from a Splitwise group by group ID and user ID once balances are settled; if the member still owes or is owed, settle up first because the request is rejected.
Instructions
Remove a member from a group. 🔒 destructive write.
Calls POST /remove_user_from_group with group_id and user_id. Splitwise refuses
when the member has a non-zero balance in the group (settle up first) — and it does so
with HTTP 200 + success: false, which the client turns into an error. The member is
reported as removed only when the body says success: true. Refused with
Error: … writes are disabled unless SPLITWISE_ALLOW_WRITES=1. Undo:
splitwise_add_user_to_group with the same ids.
When to Use:
To drop someone (or yourself) from a group whose balances are settled.
When NOT to Use:
To delete the whole group (use
splitwise_delete_group).To check balances first (use
splitwise_get_group).With a group NAME — resolve it to an id first (use
splitwise_resolve_group).
Returns:
A confirmation with the success / errors values Splitwise returned — or, when the
body does not say success: true, a note to verify before reporting it as removed.
Examples:
params = {"group_id": 12345, "user_id": 5823}
Error Handling:
A non-zero balance (or any refusal) → Error: Splitwise rejected the request ... with
Splitwise's message; 403 → you are not a member of the group.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |