Attention: There will be major changes to the API soon that will require migration work. Please check our upcoming releases page frequently for updates.
v4.9 of the API has released! See change log.

REST Resource: accounts.admins

Resource: Admin

An administrator of an Account or a Location.

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

string

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

For location admins, this is in the form: accounts/{accountId}/locations/{locationId}/admins/{adminId}

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

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

Methods

create
(deprecated)

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

delete
(deprecated)

Removes the specified admin from the specified account.

list
(deprecated)

Lists the admins for the specified account.

patch
(deprecated)

Updates the Admin for the specified Account Admin.