Synup
Schlüssel erstellen
v1Ressourcen/Clients/getStandard-Benachrichtigungen für Kunden abrufen

Standard-Benachrichtigungen für Kunden abrufen

Gibt die Benachrichtigungsvorgaben zurück, mit denen jeder Kunde in Ihrem Workspace startet: über welche Ereignisse Benutzer des Kundenportals informiert werden, im Portal (inApp) und per E-Mail, und ob Kunden die Benachrichtigungsseite im Portal öffnen und ihre eigene Auswahl ändern können. Ein Kunde mit eigenen Benachrichtigungseinstellungen (siehe /api/v1/clients/{id}/notifications) verwendet stattdessen diese. Jedes Mitglied mit Zugriff auf Kunden kann die Vorgaben lesen. canManage gibt an, ob das Mitglied hinter dem Schlüssel sie ändern darf.

get/api/v1/settings/client-notifications
clients:read
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
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.
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.
get/api/v1/settings/client-notifications
Ihr API-Schlüssel
{}

Anleitungen, die diese Ressource verwenden