REST Resource: accounts.invitations

  • This documentation details the 'Invitation' resource, which represents a pending invitation to a Google Business Profile account or location.

  • Invitations specify a role for the invitee and the target account or location.

  • A TargetLocation object is used when the invitation is for a specific location within a business account, providing the location's name and address.

  • The available methods (accept, decline, list) for managing invitations are deprecated.

Resource: Invitation

Output only. Represents a pending invitation.

JSON representation 
{
  "name": string,
  "role": enum (AdminRole),

  // Union field target can be only one of the following:
  "targetAccount": {
    object (Account)
  },
  "targetLocation": {
    object (TargetLocation)
  }
  // End of list of possible types for union field target.
}
Fields
name

string

The resource name for the invitation.
role

enum (AdminRole)

The invited role on the account.
Union field target. Indicates the target this invitation is for. target can be only one of the following:
targetAccount

object (Account)

The sparsely populated account this invitation is for.
targetLocation

object (TargetLocation)

The target location this invitation is for.

TargetLocation

Represents a target location for a pending invitation.

JSON representation 
{
  "locationName": string,
  "locationAddress": string
}
Fields
locationName

string

The name of the location to which the user is invited.
locationAddress

string

The address of the location to which the user is invited.

Methods

accept
(deprecated)

 Accepts the specified invitation.

decline
(deprecated)

 Declines the specified invitation.

list
(deprecated)

 Lists pending invitations for the specified account.