Synupv1
Créer une clé
v1Ressources/Clients/postEnvoyer l'invitation au portail client

Envoyer l'invitation au portail client

Envoie (ou renvoie) l'e-mail d'invitation au portail client au contact principal d'un client — un lien magique sans mot de passe. Le renvoyer invalide tout lien précédemment envoyé. Échoue si le client n'a pas de primaryContactEmail défini.

post/api/v1/clients/{id}/invite
clients:write
Paramètres de requête
idstringobligatoire
Le client à inviter.
Réponse
dataobjectfacultatif
portalLinkstringfacultatif
L'URL du lien magique envoyé dans l'e-mail d'invitation.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/clients/{id}/invite
Votre clé API
id *
{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}