Synup
Create a key
v1Resources/Clients/patchUpdate client notifications

Update client notifications

Read effective notification settings and edit eligibility. Owner/admin writes may change supported switches, preserving omitted values; config=null restores agency defaults. Notification delivery workers and internal settings are not exposed.

patch/api/v1/clients/{id}/notifications
clients:write
Query parameters
idstringrequired
Request body
patchobjectoptional
Changes only the fields you name, for this client or, with clientUserId, for one of its portal users. null clears a field so it falls back to the level above: the agency defaults for a client, the client's settings for a portal user. Fields you leave out stay as they are.
configobjectoptional
Saves the client's whole list in one go. null drops the client's own settings so it follows the agency defaults again. Can't be combined with clientUserId.
resetboolean (true)optional
true drops the saved settings, so the client follows the agency defaults again, or the portal user named in clientUserId follows the client's settings again.
clientUserIdstringoptional
Apply patch or reset to one active portal user of this client instead of to the client as a whole.
Response
dataobjectrequired
configobjectoptional
showToClientsbooleanoptional
lockedbooleanoptional
rowsobjectoptional
customizedbooleanoptional
canManagebooleanoptional
emailReadybooleanoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
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.
patch/api/v1/clients/{id}/notifications
Your API key
id *
Request body
{}

Guides that use this resource