Synup
Créer une clé
v1Ressources/Clients/getConsulter les notifications par défaut des clients

Consulter les notifications par défaut des clients

Renvoie les notifications par défaut avec lesquelles chaque client de votre workspace démarre : les événements signalés aux utilisateurs du portail client, dans le portail (inApp) et par e-mail, et la possibilité pour les clients d'ouvrir la page de notifications du portail et de modifier leurs propres choix. Un client qui a ses propres réglages de notifications (voir /api/v1/clients/{id}/notifications) les utilise à la place. Tout membre ayant accès aux Clients peut lire ces valeurs. canManage indique si le membre derrière la clé peut les modifier.

get/api/v1/settings/client-notifications
clients:read
Réponse
dataobjectobligatoire
configobjectfacultatif
Les valeurs en vigueur sous forme de liste complète : les deux interrupteurs de la page et chaque ligne.
vinteger (1)facultatif
showToClientsbooleanfacultatif
Si les utilisateurs du portail client voient la page de gestion des notifications.
lockedbooleanfacultatif
Si la liste des notifications est en lecture seule pour les clients. Les choix propres d'un utilisateur client ne comptent que tant que la page est affichée et non verrouillée.
rowsobjectfacultatif
Chaque ligne de notification par id, avec inApp et email activés ou désactivés.
customizedbooleanfacultatif
true si votre workspace a enregistré ses propres valeurs ; false s'il utilise les valeurs intégrées.
canManagebooleanfacultatif
Si le membre derrière cette clé est propriétaire ou administrateur de l'agence et peut modifier les valeurs.
emailReadybooleanfacultatif
Si votre workspace dispose d'un domaine d'envoi vérifié. Tant que ce n'est pas le cas, aucun e-mail de notification n'atteint les clients, quels que soient les interrupteurs e-mail.
settingsobjectfacultatif
Les mêmes valeurs, ligne par ligne, avec l'origine de chacune.
scopeobjectfacultatif
kindstring (agency)facultatif
customizedbooleanfacultatif
true si votre workspace a enregistré ses propres valeurs ; false s'il utilise les valeurs intégrées.
showToClientsobjectfacultatif
Si les utilisateurs du portail client voient la page de gestion des notifications.
valuebooleanfacultatif
fromstring (default | agency)facultatif
lockedobjectfacultatif
Si la liste des notifications est en lecture seule pour les clients. Les choix propres d'un utilisateur client ne comptent que tant que la page est affichée et non verrouillée.
valuebooleanfacultatif
fromstring (default | agency)facultatif
rowsarray of objectfacultatif
Une entrée par ligne de notification, dans l'ordre d'affichage.
idstring (approvalRequested | workAssigned | approvalOverdue | commentReplied | workUpdated | reviewsNew | reviewsLow | reviewFetchFinished | reportReady | postPublishFailed | postIdeasReady | clientCredits | connectionReconnect)facultatif
L'id fixe de la ligne. Utilisez-le comme clé sous rows lors d'une modification.
categorystring (work | reviews | reports | posts | credits | connections)facultatif
Le groupe de la ligne : work, reviews, reports, posts, credits ou connections.
locationsbooleanfacultatif
Si la ligne peut être limitée à certains emplacements. Toujours false à ce niveau, car les listes d'emplacements se définissent par client.
inAppobjectfacultatif
La notification de la ligne dans le portail.
emailobjectfacultatif
La notification de la ligne par e-mail.
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.
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.
get/api/v1/settings/client-notifications
Votre clé API
{}

Guides qui utilisent cette ressource