REST Resource: locations.admins

  • An Admin is an administrator of an Account or a location, with an immutable resource name and a role specifying their access level.

  • Admins can be invited, removed, listed, and updated for specific locations using provided methods.

  • Admin creation requires the role field, while optional fields include the admin's name/email and associated account.

  • A pending invitation status is indicated for each admin, along with whether it's for an Account or Location.

  • Admins for Accounts are in the form accounts/{account_id}/admins/{admin_id} and for Locations are in the form locations/{locationId}/admins/{admin_id}.

Resource: Admin

An administrator of an Account or a location.

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

string

Immutable. 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: locations/{locationId}/admins/{admin_id}

This field will be ignored if set during admin creation.
admin

string

Optional. 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.

This field is only needed to be set during admin creation.
account

string

Immutable. The name of the Account resource that this Admin refers to. Used when calling locations.admins.create to invite a LocationGroup as an admin.

If both this field and admin are set on CREATE requests, this field takes precedence and the email address in admin will be ignored.

Format: accounts/{account}.
role

enum (AdminRole)

Required. Specifies the role that this admin uses with the specified Account or Location.
pendingInvitation

boolean

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

Methods

create

 Invites the specified user to become an administrator for the specified location.

delete

 Removes the specified admin as a manager of the specified location.

list

 Lists all of the admins for the specified location.

patch

 Updates the Admin for the specified location.