v1Ressources/Clients/patchModifier les notifications par défaut des clients
Modifier les notifications par défaut des clients
Modifie les notifications par défaut de tous les clients de votre workspace. Envoyez exactement un champ parmi patch, config ou reset ; aucun, ou plusieurs, renvoie 400. Seul un propriétaire ou un administrateur de l'agence peut faire ce changement, et la clé comme le membre doivent avoir accès à tous les clients : une clé ou un membre limité à certains clients reçoit 403, car ces valeurs s'appliquent à tous les clients. Les listes d'emplacements ne peuvent pas être définies ici, car un emplacement appartient à un seul client ; définissez-les par client. Un 409 signifie que les réglages ont changé au même moment : relisez-les et réessayez. La réponse est identique à celle de GET et montre les réglages en vigueur.
patch
clients:write/api/v1/settings/client-notificationsCorps de la requête
patchobjectfacultatif
Modifie uniquement les champs que vous indiquez. Une valeur définit le champ ; null l'efface pour revenir à la valeur intégrée. Les champs omis restent inchangés.
showToClientsbooleanfacultatif
Si les utilisateurs du portail client voient la page de gestion des notifications. null revient à la valeur intégrée (true).
lockedbooleanfacultatif
Si la liste des notifications est en lecture seule pour les clients. null revient à la valeur intégrée (false). Si la page est masquée, la liste est toujours enregistrée déverrouillée.
rowsobjectfacultatif
Modifications par ligne de notification, indexées par id de ligne (approvalRequested, workAssigned, approvalOverdue, commentReplied, workUpdated, reviewsNew, reviewsLow, reviewFetchFinished, reportReady, postPublishFailed, postIdeasReady, clientCredits, connectionReconnect). Chaque ligne accepte inApp et email, indépendamment. Un id de ligne inconnu renvoie 400.
configobjectfacultatif
Enregistre toute la liste en une fois. Les lignes et options omises gardent leurs valeurs actuelles. null supprime les valeurs enregistrées de votre workspace et revient aux valeurs intégrées.
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
Interrupteurs par id de ligne, avec inApp et email en booléens. Un id de ligne inexistant, ou une valeur qui n'est pas un booléen, renvoie 400.
resetboolean (true)facultatif
true supprime les valeurs enregistrées de votre workspace et revient aux valeurs intégrées.
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
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.
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/settings/client-notifications
Votre clé API
Corps de la requête
{}Guides qui utilisent cette ressource
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- Create a Location with the Synup APICreate a business location in one POST, with or without a client, get back a locationId, and know which fields matter and which can wait.
- How to Build a Reputation Management PlatformArchitecture and API calls for a multi-client reputation management platform on Synup: review ingestion, reply workflows, invites, widgets and reporting.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build a White-Label Local Marketing PlatformBuild a multi-tenant white-label local marketing platform on the API, with client provisioning, team access, per-client summaries and scoped API keys.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.