Delete User Account | Edgenivo SDK

APIs & SDKs

Delete User Account

DEL/__remote/api.vercel.com/v1/user

Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process.

Request

import { Edgenivo } from "@vercel/sdk";

const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.user.requestDelete({});

  console.log(result);
}

run();

Response

{
  "email": "user@example.com",
  "id": "icfg_1234567890",
  "message": "Verification email sent"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Body

application/json

reasonsarrayOptional

Optional array of objects that describe the reason why the User account is being deleted.

Response

202Response indicating that the User deletion process has been initiated, and a confirmation email has been sent.

emailstringRequired

Email address of the User who has initiated deletion.

idstringRequired

Unique identifier of the User who has initiated deletion.

messagestringRequired

User deletion progress status.

Errors

400One of the provided values in the request body is invalid.

401Error

402Error

403You do not have permission to access this resource.

410Error

Request

import { Edgenivo } from "@vercel/sdk";

const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.user.requestDelete({});

  console.log(result);
}

run();

Response

{
  "email": "user@example.com",
  "id": "icfg_1234567890",
  "message": "Verification email sent"
}

OpenAPI Specification