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

Envoyer l'invitation au portail client

Envoyer ou renvoyer une invitation au contact principal, ou utiliser clientUserId pour un utilisateur actif attendant sa première connexion. Sans contenu, le contact principal reste ciblé; le JSON incorrect est refusé. Renvoie portalLink. Les anciens liens restent valides jusqu’à utilisation ou expiration après sept jours. Le titulaire identifié du jeton doit accéder au client.

post/api/v1/clients/{id}/invite
clients:write
Paramètres de requête
idstringobligatoire
Le client à inviter.
Corps de la requête
clientUserIdstringfacultatif
Réponse
dataobjectfacultatif
portalLinkstringfacultatif
L'URL du lien magique envoyé dans l'e-mail d'invitation.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
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.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
503Le service est temporairement indisponible. Réessayez l’ajout de crédits avec la même clé d’idempotence.
post/api/v1/clients/{id}/invite
Votre clé API
id *
Corps de la requête
{
  "data": {
    "portalLink": "https://portal.synup.com/invite/aB3dE9fGhJ"
  }
}

Guides qui utilisent cet endpoint