Synup
Create a key
v1Resources/Clients/getGet client notification defaults

Get client notification defaults

Returns the notification defaults every client in your workspace starts from: which events client portal users hear about, in the portal (inApp) and by email, and whether clients can open the portal's notification page and change their own choices. A client that has its own notification settings (see /api/v1/clients/{id}/notifications) uses those instead. Any member with access to Clients can read the defaults. canManage says whether the member behind the key may change them.

get/api/v1/settings/client-notifications
clients:read
Response
dataobjectrequired
configobjectoptional
The defaults in force, as a complete list: both page switches and every row.
vinteger (1)optional
showToClientsbooleanoptional
Whether client portal users see the Manage notifications page.
lockedbooleanoptional
Whether the notification list is read-only for clients. A client user's own choices only count while the page is shown and not locked.
rowsobjectoptional
Every notification row by id, with inApp and email on or off.
customizedbooleanoptional
true when your workspace has saved its own defaults; false when it uses the built-in ones.
canManagebooleanoptional
Whether the member behind this key is an agency owner or admin and can change the defaults.
emailReadybooleanoptional
Whether your workspace has a verified sending domain. Until it does, no notification email reaches clients, whatever the email switches say.
settingsobjectoptional
The same defaults, row by row, with where each value comes from.
scopeobjectoptional
kindstring (agency)optional
customizedbooleanoptional
true when your workspace has saved its own defaults; false when it uses the built-in ones.
showToClientsobjectoptional
Whether client portal users see the Manage notifications page.
valuebooleanoptional
fromstring (default | agency)optional
lockedobjectoptional
Whether the notification list is read-only for clients. A client user's own choices only count while the page is shown and not locked.
valuebooleanoptional
fromstring (default | agency)optional
rowsarray of objectoptional
One entry per notification row, in display order.
idstring (approvalRequested | workAssigned | approvalOverdue | commentReplied | workUpdated | reviewsNew | reviewsLow | reviewFetchFinished | reportReady | postPublishFailed | postIdeasReady | clientCredits | connectionReconnect)optional
The row's stable id. Use it as the key under rows when you update.
categorystring (work | reviews | reports | posts | credits | connections)optional
The group the row belongs to: work, reviews, reports, posts, credits or connections.
locationsbooleanoptional
Whether the row can be limited to some locations. Always false at this level, because location lists are set per client.
inAppobjectoptional
The row's portal notification.
emailobjectoptional
The row's email notification.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Retry a credit grant with the same idempotency key.
get/api/v1/settings/client-notifications
Your API key
{}

Guides that use this resource