nooks
GitHubInstall
People and groups

Remove member

RemoveMember closes an account and deletes the Lists they started. What they added to anybody else's Lists stays, with their name gone from it: a household's shopping is not one person's to take away by leaving.

DELETE
/api/v1/members/{memberUid}

Path Parameters

memberUid*string

Query Parameters

giveListsToUid?string

Who the Lists they started are given to. Whoever removes somebody is the one who knows which of the household actually uses the shopping list, so this is a choice rather than always the Admin doing it.

deleteTheirLists?boolean

Delete those Lists instead, with everything anybody has put on them.

Exactly one of these two is required. Deleting is not what a caller gets by leaving a field out: a request naming neither is refused, so the destructive answer is one somebody gave rather than one they forgot to.

Response Body

application/json

application/json

curl -X DELETE "https://example.com/api/v1/members/string"
{}