v1Recursos/Clients/patchActualizar las notificaciones predeterminadas de clientes
Actualizar las notificaciones predeterminadas de clientes
Cambia las notificaciones predeterminadas de todos los clientes de tu workspace. Envía exactamente uno de patch, config o reset; si no envías ninguno, o más de uno, recibes 400. Solo un propietario o administrador de la agencia puede hacer este cambio, y tanto la clave como el miembro necesitan acceso a todos los clientes: una clave o un miembro limitado a algunos clientes recibe 403, porque estos valores llegan a todos los clientes. Aquí no se pueden definir listas de ubicaciones, ya que las ubicaciones pertenecen a un solo cliente; defínelas por cliente. Un 409 significa que la configuración cambió en el mismo momento: vuelve a leerla e inténtalo de nuevo. La respuesta es igual a la de GET y muestra la configuración vigente.
patch
clients:write/api/v1/settings/client-notificationsCuerpo de la solicitud
patchobjectopcional
Cambia solo los campos que indiques. Un valor define el campo; null lo borra para que vuelva al valor integrado. Los campos que omitas no cambian.
showToClientsbooleanopcional
Si los usuarios del portal del cliente ven la página para gestionar notificaciones. null vuelve al valor integrado (true).
lockedbooleanopcional
Si la lista de notificaciones es de solo lectura para los clientes. null vuelve al valor integrado (false). Si la página está oculta, la lista siempre se guarda desbloqueada.
rowsobjectopcional
Cambios por fila de notificación, con el id de fila como clave (approvalRequested, workAssigned, approvalOverdue, commentReplied, workUpdated, reviewsNew, reviewsLow, reviewFetchFinished, reportReady, postPublishFailed, postIdeasReady, clientCredits, connectionReconnect). Cada fila acepta inApp y email, de forma independiente. Un id de fila desconocido devuelve 400.
configobjectopcional
Guarda la lista completa de una vez. Las filas y opciones que omitas conservan sus valores actuales. null descarta los valores guardados de tu workspace y vuelve a los integrados.
showToClientsbooleanopcional
Si los usuarios del portal del cliente ven la página para gestionar notificaciones.
lockedbooleanopcional
Si la lista de notificaciones es de solo lectura para los clientes. Las opciones propias de un usuario del cliente solo cuentan mientras la página se muestra y no está bloqueada.
rowsobjectopcional
Interruptores por id de fila, con inApp y email como booleanos. Un id de fila que no existe, o un valor que no es booleano, devuelve 400.
resetboolean (true)opcional
true descarta los valores guardados de tu workspace y vuelve a los integrados.
Respuesta
dataobjectobligatorio
configobjectopcional
Los valores vigentes como lista completa: ambos interruptores de la página y todas las filas.
vinteger (1)opcional
showToClientsbooleanopcional
Si los usuarios del portal del cliente ven la página para gestionar notificaciones.
lockedbooleanopcional
Si la lista de notificaciones es de solo lectura para los clientes. Las opciones propias de un usuario del cliente solo cuentan mientras la página se muestra y no está bloqueada.
rowsobjectopcional
Cada fila de notificación por id, con inApp y email activados o desactivados.
customizedbooleanopcional
true cuando tu workspace guardó sus propios valores; false cuando usa los integrados.
canManagebooleanopcional
Si el miembro detrás de esta clave es propietario o administrador de la agencia y puede cambiar los valores.
emailReadybooleanopcional
Si tu workspace tiene un dominio de envío verificado. Mientras no lo tenga, ningún correo de notificación llega a los clientes, digan lo que digan los interruptores de correo.
settingsobjectopcional
Los mismos valores, fila por fila, con el origen de cada uno.
scopeobjectopcional
kindstring (agency)opcional
customizedbooleanopcional
true cuando tu workspace guardó sus propios valores; false cuando usa los integrados.
showToClientsobjectopcional
Si los usuarios del portal del cliente ven la página para gestionar notificaciones.
valuebooleanopcional
fromstring (default | agency)opcional
lockedobjectopcional
Si la lista de notificaciones es de solo lectura para los clientes. Las opciones propias de un usuario del cliente solo cuentan mientras la página se muestra y no está bloqueada.
valuebooleanopcional
fromstring (default | agency)opcional
rowsarray of objectopcional
Una entrada por fila de notificación, en orden de visualización.
idstring (approvalRequested | workAssigned | approvalOverdue | commentReplied | workUpdated | reviewsNew | reviewsLow | reviewFetchFinished | reportReady | postPublishFailed | postIdeasReady | clientCredits | connectionReconnect)opcional
El id fijo de la fila. Úsalo como clave dentro de rows al actualizar.
categorystring (work | reviews | reports | posts | credits | connections)opcional
El grupo de la fila: work, reviews, reports, posts, credits o connections.
locationsbooleanopcional
Si la fila se puede limitar a algunas ubicaciones. Siempre false en este nivel, porque las listas de ubicaciones se definen por cliente.
inAppobjectopcional
La notificación de la fila en el portal.
emailobjectopcional
La notificación de la fila por correo.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
503El servicio no está disponible temporalmente. Reintente la asignación de créditos con la misma clave de idempotencia.
patch/api/v1/settings/client-notifications
Su clave de API
Cuerpo de la solicitud
{}Guías que usan este recurso
- 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.