Delete a member and all related records

DELETE /api/members/{memberId}/profile

• Products: Operator (FOH)
• Features: Front of House Generic Access (FOHGENERIC)

Overview

Removes an unconfirmed member and the records hanging off them. Despite the title, this is not a general-purpose erasure endpoint and it will not satisfy a data deletion request against an established member: it refuses to delete anyone who is not flagged as pending confirmation. Its real job is clearing up sign-ups that were started and never completed — a join that was abandoned before payment, a duplicate created in error, a test registration.

All four of these must hold, and are checked before anything is written:

• the member exists;
• the member is pending confirmation — the flag you set by sending pendingConfirmation: true to POST {base_url}/api/members/profile, and which is cleared once the member confirms;
• none of the member's sales invoices has a non-zero amount paid — a single paid invoice blocks the delete permanently, and there is no override on this endpoint;
• no other member is linked to this one, which would make it a primary member; unlink the others first.

It is a hard delete, not an anonymisation. There is no soft-delete flag, no tombstone and no anonymised remnant: the records are removed. The member and the following related records are removed together as a single operation, so the operation either completes in full or leaves the member untouched:

• member user fields
• bank accounts
• event logs, and member event logs
• subscriptions, and for each of them its subscription products and its promotion usages
• sales invoices, and for each of them its invoice products
• member consents
• member agreements
• member personalisations

Nothing outside that list is removed explicitly.

The only trace kept is a system event log entry recording that an unconfirmed member was deleted, against the deleted member's id.

The call is not idempotent in its status codes: the first successful delete returns 204 with no body, and repeating it returns 404 because the member has gone. As for who may call it, the route id must match the member your access token identifies, or a member linked to them; a caller whose token does not identify a member — a server-to-server integration — is not subject to that check and can delete any member that meets the four conditions above.

Endpoint

DELETE {base_url}/api/members/{memberId}/profile

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Sample request

curl -X DELETE '{base_url}/api/members/{memberId}/profile' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Errors

This page as markdown · All pages · llms.txt