deleteUserHard

Allows yopmail.com users typically used for testing and test automation to be "hard deleted" from the system to help clean up test accounts.

Request

DELETE /rest/internal/user

Headers

Header	Required	Description
x-nextinteract-company-api-key	Yes	Admin-specific API key UUID provided to company

Parameters

Parameter	Type	Required	Description
userId	Integer	No	User id to delete.
userEmail	String	No	User email to delete.

NOTE: only one of the above can be passed but at least one of them must be passed.

Response

200 for successful delete. No BODY returned for HTTP DELETE

400 for invalid request object such as API Key or userId or userEmail or Email not "@yopmail.com" 500 if a server error occurred. OK

Sample calls: /rest/internal/user?userId=123 /rest/internal/user?userEmail=abc@yopmail.com

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSIncorrectApiKeyTypeException	See Error Definitions
WSInvalidSystemConfigurationException	See Error Definitions
WSCompanyApiKeyNotActiveException	See Error Definitions
WSRecordNotFoundException	See Error Definitions
WSUserServiceException	See Error Definitions
WSUserNotFoundException	See Error Definitions
WSOperationNotSupportedException	See Error Definitions