/users/{email}

DELETE /users/{email}

Delete a user

Deletes a user by their email address

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

email path string

Email address of the user to delete

Optional Parameters

Click here to view an exhaustive list of all available parameters

x-account-id header string

The account ID for the request

Try it out

Output:

Responses

Description

User deleted successfully

{
  "message": "User deleted successfully"
}

Description

Unauthorized - not authenticated

{
  "error": "string",
  "status": 0
}

Description

Forbidden - user does not have required permissions

{
  "error": "string",
  "status": 0
}

Description

Not found - user with specified email does not exist

{
  "error": "string",
  "status": 0
}

Description

Internal server error

{
  "error": "string",
  "status": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/Error

in: header
name: x-account-id
schema:
  type: string
description: The account ID for the request
required: false

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
description: Error response object

|
export interface Error {
  /** Error message */
  error?: string;
  /** HTTP status code */
  status?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /users/[email]/route.ts

Or the swagger.yaml spec this documentation was generated from: /users/swagger.yaml