Users

Archive User

Soft delete (archive) a User account. This action is reversible.

Authorization

Public key Secret key

x-fngs-public-key<token>

In: header

x-fngs-secret-key<token>

In: header

userId*string

Unique identifier of the User to archive.

Formatuuid

application/json

PATCH /v0/users/:userId/archive Request body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/v0/users/123e4567-e89b-12d3-a456-426614174000/archive" \  -H "Content-Type: application/json" \  -d '{}'

{  "status": "success",  "data": {    "success": true,    "archived": true  }}

Update User details PATCH

Update an existing User's data and billing details.

Unarchive User PATCH

Restore a User account that has been previously archived.