Loading...

Knowledge Base

Delete Multiple Users for Business and Enterprise Email via API

When you want to remove multiple users from Business and Enterprise Email using the API. This article explains the required parameters and API request format for deleting users in bulk.

Delete Users

 

Description

Deletes a list of users.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
order-idIntegerRequiredOrder ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
emailsStringRequiredComma-separated email addresses of users

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/users/delete.json?auth-userid=0&api-key=key&order-id=0&emails=username1@domainname.com,username2@domainname.com

Response

Returns "SUCCESS" as the status if users deleted successfully.