Delete User

This API allows you to delete an existing user.

Use this API to delete an existing user. Remove a user if any of the following is true:

  • If it is no longer needed or is no longer a member of the team
  • If any duplicate has been created
  • If created mistakenly

Sample Request

curl --request DELETE \
     --url \
     --header 'accept: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Path Params)

The following parameter is required to delete a user:

Variable NameDescriptionData Type
idID of the user.String

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
SuccessThe request success status, the possible values are: True (default) for success. False for failure.Boolean
MessageThe message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here.String
ErrorThe error type is shown is here, if any variable input is not selected properly.Object
Click Try It! to start a request and see the response here!