Loading...

Knowledge Base
Home 
 
/
 Delete Google Workspace Accounts Using the API
Categories: Google Workspace API

Delete Google Workspace Accounts Using the API

When you want to delete user accounts from an existing Google Workspace order using the API. This article explains the required parameters, regional API endpoints, eligibility limitations, and example API requests for deleting accounts. 


Delete Accounts

Description

Deletes email accounts from an existing Google Workspace order.

Note
  • Deletion is only possible for orders with monthly tenure. We do not support deletion of email accounts for orders on the annual plan. 
  • We do not offer any refunds on accounts that are deleted.
NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
order-idIntegerRequiredThe Order Id for which Accounts need to be deleted.
no-of-accountsIntegerRequiredThe number of Accounts to be deleted.

HTTP Method

POST

Example Test URL Request

India

https://test.httpapi.com/api/gapps/in/delete-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=2

South East Asia & Egypt

https://test.httpapi.com/api/gapps/se/delete-account.json?auth-userid=0&api-key=key&order-id=0&no-of-accounts=2

Rest of the World

https://test.httpapi.com/api/gapps/gbl/delete-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 G Suite Order (entityid)

  • Action Type (actiontype)

  • Description of the Accounts Deletion Action (actiontypedesc)

  • Action Id of the Accounts Deletion Action (eaqid)

  • Accounts Deletion Action Status (actionstatus)

  • Description of the Accounts Deletion Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.