GOgoogle
locations

POST /v1/locations/{locationsId}/admins

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. See AcceptInvitation to programmatically accept an invitation.

Request

Path parameters

locationsIdstring required

Request body

accountstring

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

adminstring

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.

namestring

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/{location_id}/admins/{admin_id} This field will be ignored if set during admin creation.

pendingInvitationboolean

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

role'ADMIN_ROLE_UNSPECIFIED' | 'PRIMARY_OWNER' | 'OWNER' | 'MANAGER' | 'SITE_MANAGER'

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

Response

Successful response

accountstring

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

adminstring

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.

namestring

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/{location_id}/admins/{admin_id} This field will be ignored if set during admin creation.

pendingInvitationboolean

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

role'ADMIN_ROLE_UNSPECIFIED' | 'PRIMARY_OWNER' | 'OWNER' | 'MANAGER' | 'SITE_MANAGER'

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

Changes

No recorded changes to this operation across all 3 revisions of this API.