v1Ressourcen/Clients/patchStandard-Benachrichtigungen für Kunden ändern
Standard-Benachrichtigungen für Kunden ändern
Ändert die Benachrichtigungsvorgaben für alle Kunden in Ihrem Workspace. Senden Sie genau eines von patch, config oder reset; keines oder mehrere davon liefert 400. Nur Inhaber oder Administratoren der Agentur können diese Änderung vornehmen, und Schlüssel und Mitglied brauchen beide Zugriff auf alle Kunden: Ein Schlüssel oder Mitglied, das auf einige Kunden beschränkt ist, erhält 403, weil diese Vorgaben jeden Kunden betreffen. Standortlisten lassen sich hier nicht festlegen, da Standorte zu einem einzelnen Kunden gehören; legen Sie sie pro Kunde fest. Ein 409 bedeutet, dass sich die Einstellungen im selben Moment geändert haben: Lesen Sie sie erneut und versuchen Sie es noch einmal. Die Antwort entspricht der von GET und zeigt die jetzt geltenden Einstellungen.
patch
clients:write/api/v1/settings/client-notificationsAnfragetext
patchobjectoptional
Ändert nur die Felder, die Sie angeben. Ein Wert setzt das Feld; null leert es, sodass der integrierte Standardwert gilt. Ausgelassene Felder bleiben unverändert.
showToClientsbooleanoptional
Ob Benutzer des Kundenportals die Seite zum Verwalten der Benachrichtigungen sehen. null stellt den integrierten Standardwert (true) wieder her.
lockedbooleanoptional
Ob die Benachrichtigungsliste für Kunden schreibgeschützt ist. null stellt den integrierten Standardwert (false) wieder her. Ist die Seite ausgeblendet, wird die Liste immer entsperrt gespeichert.
rowsobjectoptional
Änderungen pro Benachrichtigungszeile, nach Zeilen-ID (approvalRequested, workAssigned, approvalOverdue, commentReplied, workUpdated, reviewsNew, reviewsLow, reviewFetchFinished, reportReady, postPublishFailed, postIdeasReady, clientCredits, connectionReconnect). Jede Zeile nimmt inApp und email an, unabhängig voneinander. Eine unbekannte Zeilen-ID liefert 400.
configobjectoptional
Speichert die ganze Liste auf einmal. Ausgelassene Zeilen und Schalter behalten ihre aktuellen Werte. null verwirft die gespeicherten Vorgaben Ihres Workspace und kehrt zu den integrierten zurück.
showToClientsbooleanoptional
Ob Benutzer des Kundenportals die Seite zum Verwalten der Benachrichtigungen sehen.
lockedbooleanoptional
Ob die Benachrichtigungsliste für Kunden schreibgeschützt ist. Die eigene Auswahl eines Kundenbenutzers zählt nur, solange die Seite angezeigt wird und nicht gesperrt ist.
rowsobjectoptional
Ein/Aus-Schalter pro Zeilen-ID, mit inApp und email als Boolean. Eine nicht vorhandene Zeilen-ID oder ein Wert, der kein Boolean ist, liefert 400.
resetboolean (true)optional
true verwirft die gespeicherten Vorgaben Ihres Workspace und kehrt zu den integrierten zurück.
Antwort
dataobjecterforderlich
configobjectoptional
Die geltenden Vorgaben als vollständige Liste: beide Seitenschalter und jede Zeile.
vinteger (1)optional
showToClientsbooleanoptional
Ob Benutzer des Kundenportals die Seite zum Verwalten der Benachrichtigungen sehen.
lockedbooleanoptional
Ob die Benachrichtigungsliste für Kunden schreibgeschützt ist. Die eigene Auswahl eines Kundenbenutzers zählt nur, solange die Seite angezeigt wird und nicht gesperrt ist.
rowsobjectoptional
Jede Benachrichtigungszeile nach ID, mit inApp und email ein oder aus.
customizedbooleanoptional
true, wenn Ihr Workspace eigene Vorgaben gespeichert hat; false, wenn er die integrierten verwendet.
canManagebooleanoptional
Ob das Mitglied hinter diesem Schlüssel Inhaber oder Administrator der Agentur ist und die Vorgaben ändern kann.
emailReadybooleanoptional
Ob Ihr Workspace eine verifizierte Absenderdomain hat. Solange das nicht der Fall ist, erreicht keine Benachrichtigungs-E-Mail Ihre Kunden, unabhängig von den E-Mail-Schaltern.
settingsobjectoptional
Dieselben Vorgaben Zeile für Zeile, mit der Herkunft jedes Werts.
scopeobjectoptional
kindstring (agency)optional
customizedbooleanoptional
true, wenn Ihr Workspace eigene Vorgaben gespeichert hat; false, wenn er die integrierten verwendet.
showToClientsobjectoptional
Ob Benutzer des Kundenportals die Seite zum Verwalten der Benachrichtigungen sehen.
valuebooleanoptional
fromstring (default | agency)optional
lockedobjectoptional
Ob die Benachrichtigungsliste für Kunden schreibgeschützt ist. Die eigene Auswahl eines Kundenbenutzers zählt nur, solange die Seite angezeigt wird und nicht gesperrt ist.
valuebooleanoptional
fromstring (default | agency)optional
rowsarray of objectoptional
Ein Eintrag pro Benachrichtigungszeile, in Anzeigereihenfolge.
idstring (approvalRequested | workAssigned | approvalOverdue | commentReplied | workUpdated | reviewsNew | reviewsLow | reviewFetchFinished | reportReady | postPublishFailed | postIdeasReady | clientCredits | connectionReconnect)optional
Die feste ID der Zeile. Verwenden Sie sie beim Ändern als Schlüssel unter rows.
categorystring (work | reviews | reports | posts | credits | connections)optional
Die Gruppe der Zeile: work, reviews, reports, posts, credits oder connections.
locationsbooleanoptional
Ob die Zeile auf einige Standorte beschränkt werden kann. Auf dieser Ebene immer false, weil Standortlisten pro Kunde festgelegt werden.
inAppobjectoptional
Die Portal-Benachrichtigung der Zeile.
emailobjectoptional
Die E-Mail-Benachrichtigung der Zeile.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
409Die Anfrage steht im Widerspruch zum aktuellen Zustand der Ressource — zum Beispiel beim Ändern der E-Mail-Adresse oder Telefonnummer eines Empfängers, dem bereits eine Nachricht gesendet wurde, oder bei einer Team-Einladung, die bereits akzeptiert wurde (oder noch nicht akzeptiert wurde).
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
503Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie eine Gutschrift mit demselben Idempotenzschlüssel.
patch/api/v1/settings/client-notifications
Ihr API-Schlüssel
Anfragetext
{}Anleitungen, die diese Ressource verwenden
- 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.