Synup
Créer une clé
v1Ressources/Clients/postAjouter un utilisateur au portail client

Ajouter un utilisateur au portail client

Lire les utilisateurs enregistrés sans créer d’anciens utilisateurs de contact. Ajouter par e-mail, avec sendInvite=true par défaut; un échec d’envoi conserve l’utilisateur. Les modifications permettent seulement activation, désactivation ou transfert de propriété avec makePrimary=true. La suppression expire les liens; un propriétaire ayant d’autres utilisateurs ne peut pas être supprimé. La révocation expire tous les liens en attente et supprime seulement les invités jamais connectés.

post/api/v1/clients/{id}/users
clients:write
Paramètres de requête
idstringobligatoire
Corps de la requête
emailstringobligatoire
firstNamestringfacultatif
lastNamestringfacultatif
sendInvitebooleanfacultatif
Réponse
dataobjectobligatoire
userobjectfacultatif
idstringfacultatif
emailstringfacultatif
firstNamestringfacultatif
lastNamestringfacultatif
statusstringfacultatif
isPrimarybooleanfacultatif
rolestring (owner | member)facultatif
invitedAtstringfacultatif
lastLoginAtstringfacultatif
inviteSentAtstringfacultatif
inviteobjectfacultatif
sentbooleanfacultatif
portalLinkstringfacultatif
reasonstring (portal_domain_required | send_failed)facultatif
errorstringfacultatif
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}/users
Votre clé API
id *
Corps de la requête*
{}

Guides qui utilisent cette ressource