Erase a user

DELETE

/api/v1/sites/{siteId}/users/{userId}

Queues the erasure of everything stored about the user on this site: events, session replays, aliases, the link of their payments and the profile. 202 with the job id, whether or not the user exists; 503 while background jobs are not running.

Requires users:delete on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: users:delete

Path Parameters

siteId*string

userId*string

Length1 <= length <= 255

Response Body

Accepted

application/json

response

data*

Example Request

curl -X DELETE 'https://pilotfox.app/api/v1/sites/string/users/string'

Example ResponseSchema202

{  "data": {    "jobId": "string"  }}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body