L'API Business Profile Performance est maintenant disponible ! Veuillez indiquer un travail de migration.
Consultez le planning d'abandon et les instructions pour migrer vers la nouvelle API v1 depuis l'ancienne API v4, obsolète.
Aidez-nous à améliorer les menus en répondant à cette enquête afin de mieux comprendre quels attributs de lieux, de menus et de plats vous pouvez indiquer à propos des marchands que vous proposez.

REST Resource: locations.admins

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ressource: Admin

Administrateur d'un compte ou d'un établissement.

Représentation JSON
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
Champs
name

string

Immuable. Nom de la ressource Pour les administrateurs de compte, voici ce qui est indiqué dans le formulaire : accounts/{account_id}/admins/{admin_id}

Pour les administrateurs d'établissement, voici ce qui est indiqué dans le formulaire: locations/{locationId}/admins/{admin_id}

Ce champ sera ignoré s'il est défini lors de la création d'un administrateur.

admin

string

Facultatif. Nom de l'administrateur. Lorsque vous effectuez l'invitation initiale, il s'agit de l'adresse e-mail de l'invité. Lors des appels GET, l'adresse e-mail de l'utilisateur est renvoyée si l'invitation est toujours en attente. Sinon, il contient le prénom et le nom de l'utilisateur.

Ce champ ne doit être défini que lors de la création d'un administrateur.

account

string

Immuable. Nom de la ressource "Account" à laquelle cet administrateur fait référence. Utilisée lorsque vous appelez locations.admins.create pour inviter un groupe d'établissements LocationGroup en tant qu'administrateur.

Si ce champ et le admin sont définis sur des requêtes CREATE, ce champ est prioritaire et l'adresse e-mail dans admin sera ignorée.

Format : accounts/{account}.

role

enum (AdminRole)

Obligatoire. Indique le rôle utilisé par cet administrateur pour le compte ou l'établissement spécifié.

pendingInvitation

boolean

Uniquement en sortie. Indique si cet administrateur dispose d'une invitation en attente pour la ressource spécifiée.

Méthodes

create

Invite l'utilisateur spécifié à devenir administrateur de l'établissement indiqué.

delete

Supprime l'administrateur spécifié en tant qu'administrateur de l'établissement indiqué.

list

Répertorie tous les administrateurs de l'établissement spécifié.

patch

Met à jour l'administrateur pour l'établissement spécifié.