Skip to content
Bottle

Erase a customer

POST
/customers/{id}/erase
curl --request POST \
  --url https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/erase \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "reason": "request" }'

The personal details go and the money stays: the customer row survives with its name blanked, addresses are cleared, and orders keep what was charged, which is a record HMRC expects a business to keep for six years. A customer on legal hold is refused. This cannot be undone.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
reason
string
default: request
Allowed values: request retention

Responses

Section titled “Responses”

200

Section titled “200”

Erased

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
subject
required
string
Allowed values: customer user
subjectId
required
string
reason
required
string
Allowed values: request retention
requestedBy
required
string | null
addressesErased
required
integer
ordersKept
required
integer
ordersDeleted
required
integer
subjectDeleted
required
boolean
createdAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "subject": "customer",
  "reason": "request"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

On legal hold

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}