Synup
Créer une clé
v1Ressources/Clients/patchModifier les notifications du client

Modifier les notifications du client

Consulter les réglages effectifs et les droits de modification. Les propriétaires et administrateurs peuvent changer les options prises en charge en conservant les valeurs omises. config=null restaure les valeurs de l’agence. Les processus d’envoi et réglages internes ne sont pas exposés.

patch/api/v1/clients/{id}/notifications
clients:write
Paramètres de requête
idstringobligatoire
Corps de la requête
patchobjectfacultatif
Modifie uniquement les champs indiqués, pour ce client ou, avec clientUserId, pour l'un de ses utilisateurs du portail. null efface un champ pour que le niveau supérieur s'applique : les paramètres par défaut de l'agence pour un client, les réglages du client pour un utilisateur du portail. Les champs omis restent inchangés.
configobjectfacultatif
Enregistre toute la liste du client en une fois. null supprime les réglages propres au client, qui suit de nouveau les paramètres par défaut de l'agence. Incompatible avec clientUserId.
resetboolean (true)facultatif
true supprime les réglages enregistrés : le client suit de nouveau les paramètres par défaut de l'agence, ou l'utilisateur du portail indiqué dans clientUserId suit de nouveau les réglages du client.
clientUserIdstringfacultatif
Applique patch ou reset à un utilisateur actif du portail de ce client plutôt qu'au client dans son ensemble.
Réponse
dataobjectobligatoire
configobjectfacultatif
showToClientsbooleanfacultatif
lockedbooleanfacultatif
rowsobjectfacultatif
customizedbooleanfacultatif
canManagebooleanfacultatif
emailReadybooleanfacultatif
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.
patch/api/v1/clients/{id}/notifications
Votre clé API
id *
Corps de la requête
{}

Guides qui utilisent cette ressource