Knowledge Base
Categories: Google Workspace API
Set Up a Google Workspace Admin Account Using the API
When you want to set up an admin account for a Google Workspace order using the API. This article explains required account details, supported regions, response details, and transfer-related limitations.
Description
Adds the Admin account for an existing Google Workspace Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The OrderId for which the Admin account is to be setup. |
| email-address | String | Required | Email address for the Admin account |
| first-name | String | Required | First name for the Admin account |
| last-name | String | Required | Last name for the Admin account |
| alternate-email-address | String | Required | Alternate email address of the Customer |
| name | String | Required | Name of the Customer |
| company | String | Required | Company name of the Customer |
| zip | String | Required | Zip code of the Customer |
HTTP Method
POST
Example Test URL Request
India
https://test.httpapi.com/api/gapps/in/admin/add.json?auth-userid=0&api-key=key&order-id=0&email-address=abc@domain.com&first-name=abc&last-name=abc&name=abc&alternate-email-address=xyz@domain.com&company=test&zip=0
South East Asia & Egypt
https://test.httpapi.com/api/gapps/se/admin/add.json?auth-userid=0&api-key=key&order-id=0&email-address=abc@domain.com&first-name=abc&last-name=abc&name=abc&alternate-email-address=xyz@domain.com&company=test&zip=0
Rest of the World
hhttps://test.httpapi.com/api/gapps/gbl/admin/add.json?auth-userid=0&api-key=key&order-id=0&email-address=abc@domain.com&first-name=abc&last-name=abc&name=abc&alternate-email-address=xyz@domain.com&company=test&zip=0
Response
Returns "Success" as the status of the response if the Admin Account is setup successfully.
In case of any error, an "error" key with error description (as value) will be returned.
Note:
The admin setup call is only required if you are registering a new Google Workspace order. In the event of transfer, the admin account created with the existing provider will be used. The admin setup is no longer required while transferring the order.
Did you find this article helpful?