BusinessApi

<back to all web services

DeleteProfileRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/profile/delete
DeleteProfileRequest Parameters:
NameParameterData TypeRequiredDescription
UserHasConfirmedbodyboolNo
DeleteProfileResponse Parameters:
NameParameterData TypeRequiredDescription
UserThatWasDeletedformBusinessUserDtoYes
BusinessUserDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
FirstNameformstringNo
LastNameformstringNo
MobilePhoneformstringYes
LegalIdentityVerifiedformboolNo
LocaleformLocaleNo
Locale Enum:
EnUs
NbNo

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

HTTP + CSV

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

POST /profile/delete HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"userHasConfirmed":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"userThatWasDeleted":{"id":0,"email":"String","firstName":"String","lastName":"String","mobilePhone":"String","legalIdentityVerified":false,"locale":"EnUs"}}