Attention: There will be major changes to the API soon that will require migration work. Please check our upcoming releases page and deprecation schedule frequently for updates. You may also sign up for our mailing list to receive updates.

REST Resource: locations.admins

Resource: Admin

An administrator of an Account or a location.

JSON representation
{
  "name": string,
  "admin": 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.

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.