Delete a member

DELETE/v1/members/{id}

DELETE/v1/members/me

Deletes the member and erases their personal data. Call it from your in-app "Delete account" flow; it meets the Apple and Google rules for in-app account deletion. Deletion finishes within 30 days, usually within minutes, and a member.deleted webhook fires.

Warning Deletion can't be undone. The member's points and wallet rewards are forfeited, and their history can't be restored.

Returns 202 with no body. From then on, calls about this member return 410 member_deleted, and the guest's tokens stop working. If the same person signs up again later, create a member with the same external_id: it is a new member with a zero balance.

Permissions: {id}: secret key with members:write. me: member token.

Guide

Members and sign-in

Path parameters#

idstring (uuid)Required

Response fields#

Returns 202 with no body.

DELETE/v1/members/{id}

1
2curl -X DELETE $UNPLUG_API/members/me \
  -H "Authorization: Bearer $MEMBER_TOKEN"

1
2
3
4
5
6
7const response = await fetch(`${process.env.UNPLUG_API}/members/me`, {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.MEMBER_TOKEN}`,
  },
});
console.log(response.status);

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.delete(
    f"{os.environ['UNPLUG_API']}/members/me",
    headers={
        "Authorization": f"Bearer {os.environ['MEMBER_TOKEN']}",
    },
)
print(response.status_code)

Error descriptions#

404Not found

member_not_found

No member with this id.

410Gone

member_deleted

Deletion was already requested.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#member_not_found",
  "title": "Not found",
  "status": 404,
  "code": "member_not_found",
  "detail": "No member with this id."
}