Synup
Crear clave
v1Recursos/Clients/getConsultar las notificaciones predeterminadas de clientes

Consultar las notificaciones predeterminadas de clientes

Devuelve las notificaciones predeterminadas con las que empieza cada cliente de tu workspace: sobre qué eventos se avisa a los usuarios del portal del cliente, en el portal (inApp) y por correo, y si los clientes pueden abrir la página de notificaciones del portal y cambiar sus propias opciones. Un cliente con su propia configuración de notificaciones (consulta /api/v1/clients/{id}/notifications) usa esa en su lugar. Cualquier miembro con acceso a Clientes puede leer los valores predeterminados. canManage indica si el miembro detrás de la clave puede cambiarlos.

get/api/v1/settings/client-notifications
clients:read
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
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.
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.
get/api/v1/settings/client-notifications
Su clave de API
{}

Guías que usan este recurso