Synup
Criar chave
v1Recursos/Clients/getConsultar as notificações padrão dos clientes

Consultar as notificações padrão dos clientes

Retorna as notificações padrão com que cada cliente do seu workspace começa: sobre quais eventos os usuários do portal do cliente são avisados, no portal (inApp) e por e-mail, e se os clientes podem abrir a página de notificações do portal e alterar as próprias escolhas. Um cliente com configurações de notificação próprias (veja /api/v1/clients/{id}/notifications) usa essas no lugar. Qualquer membro com acesso a Clientes pode ler os padrões. canManage informa se o membro por trás da chave pode alterá-los.

get/api/v1/settings/client-notifications
clients:read
Resposta
dataobjectobrigatório
configobjectopcional
Os padrões em vigor como lista completa: as duas opções da página e todas as linhas.
vinteger (1)opcional
showToClientsbooleanopcional
Se os usuários do portal do cliente veem a página de gerenciar notificações.
lockedbooleanopcional
Se a lista de notificações é somente leitura para os clientes. As escolhas próprias de um usuário do cliente só valem enquanto a página estiver visível e desbloqueada.
rowsobjectopcional
Cada linha de notificação por id, com inApp e email ligados ou desligados.
customizedbooleanopcional
true quando seu workspace salvou padrões próprios; false quando usa os integrados.
canManagebooleanopcional
Se o membro por trás desta chave é proprietário ou administrador da agência e pode alterar os padrões.
emailReadybooleanopcional
Se seu workspace tem um domínio de envio verificado. Enquanto não tiver, nenhum e-mail de notificação chega aos clientes, independentemente das opções de e-mail.
settingsobjectopcional
Os mesmos padrões, linha por linha, com a origem de cada valor.
scopeobjectopcional
kindstring (agency)opcional
customizedbooleanopcional
true quando seu workspace salvou padrões próprios; false quando usa os integrados.
showToClientsobjectopcional
Se os usuários do portal do cliente veem a página de gerenciar notificações.
valuebooleanopcional
fromstring (default | agency)opcional
lockedobjectopcional
Se a lista de notificações é somente leitura para os clientes. As escolhas próprias de um usuário do cliente só valem enquanto a página estiver visível e desbloqueada.
valuebooleanopcional
fromstring (default | agency)opcional
rowsarray of objectopcional
Uma entrada por linha de notificação, na ordem de exibição.
idstring (approvalRequested | workAssigned | approvalOverdue | commentReplied | workUpdated | reviewsNew | reviewsLow | reviewFetchFinished | reportReady | postPublishFailed | postIdeasReady | clientCredits | connectionReconnect)opcional
O id fixo da linha. Use-o como chave dentro de rows ao atualizar.
categorystring (work | reviews | reports | posts | credits | connections)opcional
O grupo da linha: work, reviews, reports, posts, credits ou connections.
locationsbooleanopcional
Se a linha pode ser limitada a alguns locais. Sempre false neste nível, porque as listas de locais são definidas por cliente.
inAppobjectopcional
A notificação da linha no portal.
emailobjectopcional
A notificação da linha por e-mail.
Erros
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Tente adicionar os créditos novamente com a mesma chave de idempotência.
get/api/v1/settings/client-notifications
Sua chave de API
{}

Guias que usam este recurso