PortfolioLinkApi

<back to all web services

DeleteUser

Requires Authentication
Required permission:manageUsers
The following routes are available for this service:
POST/users/delete
DeleteUser Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNo
DeleteUserResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users/delete HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	message: String
}