Delete Email Accounts
Knowledge Base
Categories: Business & Enterprise Email API
Delete Email Accounts from Business Email Orders via API
When you want to remove email accounts from an existing Business Email order using the API. This article explains the required parameters, API request format, and response details for deleting email accounts from a Business Email order.
Description
Deletes Email Accounts from an existing Business Email Order.
Parameters
| Name | Data Type | Required / Optional | |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order ID of the Order for which Email Accounts need to be deleted |
| no-of-accounts | Integer | Required | The number of Email Accounts to be deleted |
HTTP Method
POST
Example Test URL Request
US Server https://test.httpapi.com/api/eelite/us/delete-email-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=2
Response
Returns a hash map containing the below details:
-
Domain Name (description)
-
Order Id of the Business Email Order (entityid)
-
Action Type (actiontype)
-
Description of the Email Accounts Deletion Action (actiontypedesc)
-
Action Id of the Email Accounts Deletion Action (eaqid)
-
Email Accounts Deletion Action Status (actionstatus)
-
Description of the Email Accounts Deletion Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Did you find this article helpful?