Manage admins for accounts and locations

  • The My Business Account Management API uses the term "admins" to refer to managers of business accounts and locations, providing tools to manage accounts, locations, and listing details.

  • Admins can be managed through dedicated collections and resource paths, allowing for operations like listing, adding, and removing admins for specific accounts or locations.

  • API endpoints facilitate listing existing admins, inviting new admins (users or LocationGroups) by associating their email with a Google Account, and removing admin access.

  • Admins can be assigned roles and permissions using the API, ensuring appropriate levels of access for managing business accounts and locations.

  • All admin management operations, including adding, listing, and removing, are performed using standard HTTP methods (GET, POST, DELETE) against specific API endpoints.

In the My Business Account Management API, managers for business accounts and locations are referred to as admins. To find out more about how admins can manage accounts and locations, see Business Profile accounts and location groups and Manage listing details.

Admins for accounts and locations are represented by the following collections:

The resource paths for admins are as follows: 

accounts/{accountId}/admins/{adminId}
locations/{locationId}/admins/{adminId}
 You can perform the following operations:

List admins for an account or location

Lists the admins for the specified account or location.

HTTP

To list the admins for an account 

GET
https://mybusiness.googleapis.com/v1/accounts/{accountId}/admins

To list the admins for a location 

GET
https://mybusinessaccountmanagement.googleapis.com/v1/locations/{locationId}/admins

Add an admin to an account or location

Invites someone to become an admin for an account or location. You must associate the invitee's email address with a Google Account. When the invitee signs in to Business Profile using their Google Account, they will be prompted to agree to the terms and conditions before they can make changes.

HTTP

To invite a user to be an admin for an account 

POST
https://mybusinessaccountmanagement.googleapis.com/v1/accounts/{accountId}/admins

To invite a user to be an admin for a location 

POST
https://mybusinessaccountmanagement.googleapis.com/v1/locations/{locationId}/admins
{
  "role": "MANAGER",
  "adminName": "example@example.com"
}

To invite a LocationGroup to be an admin for a location 

POST
https://mybusinessaccountmanagement.googleapis.com/v1/locations/{locationId}/admins
{
  "account": "LocationGroupID",
  "role": "MANAGER"
}

Remove an admin from an account or location

Removes an admin from the specified account or location.

HTTP

To remove an admin from an account 

DELETE
https://mybusinessaccountmanagement.googleapis.com/v1/accounts/{accountId}/admins/{adminId}

To remove an admin from a location 

DELETE
https://mybusinessaccountmanagement.googleapis.com/v1/accounts/locations/{locationId}/admins/{adminId}