Method: accounts.locations.admins.create

Invites the specified user to become an administrator for the specified location. The invitee must accept the invitation in order to be granted access to the location.

HTTP request

POST https://mybusiness.googleapis.com/v3/{name=accounts/*/locations/*}/admins

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
name

string

The resource name. For account admins, this is in the form: accounts/{account_id}/admins/{admin_id}

For location admins, this is in the form: accounts/{account_id}/locations/{location_id}/admins/{admin_id}

Request body

The request body contains data with the following structure:

JSON representation
{
  "adminName": string,
  "role": enum(AdminRole),
  "pendingInvitation": boolean,
}
Fields
adminName

string

The name of the admin. When making the initial invitation, this is the invitee's email address. On GET calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names.

role

enum(AdminRole)

Specifies the AdminRole that this admin uses with the specified Account or Location resource.

pendingInvitation

boolean

Indicates whether this admin has a pending invitation for the specified resource.

Note: This field is used in responses only. Any value specified here in a request is ignored.

Response body

If successful, the response body contains a newly created instance of Admin.

Authorization

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/plus.business.manage

For more information, see the Auth Guide.

Send feedback about...

Google My Business API
Google My Business API
Need help? Visit our support page.