API ReferenceReference
Revoke an end user's access
Sign-in stops working within moments; their data is kept. Idempotent -- revoking an already-revoked user returns the original timestamp. Billing is NOT touched: cancel any paid Stripe subscription in Stripe. Re-POSTing the same email restores access.
Requires the end_users:write scope.
Authorization
apiKey AuthorizationBearer <token>
An organization API key, created from a Storefront's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
endUserId*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/end-users/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "ok": true, "revokedAt": "2019-08-24T14:15:22Z"}