Skip to main content
POST
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Body

application/json
customer_id
string
required
kind
enum<string>
required

access asks for a copy of the customer's personal data; erasure asks for it to be erased.

Available options:
access,
erasure

Response

202 - application/json

data request recorded

id
string
required
number
string
required
kind
enum<string>
required
Available options:
access,
erasure
status
required

The values listed are the built-in ones; extensions may add more.

Available options:
awaiting_confirmation,
pending,
processing,
completed,
failed,
lapsed
requested_at
string | null
required
completed_at
string | null
required
expires_at
string | null
required
email
string
required
error_message
string | null
required
created_at
string
required
updated_at
string
required
customer_id
string | null
required
requested_by_id
string | null
required
customer
object