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

Atualizar as notificações padrão dos clientes

Altera as notificações padrão de todos os clientes do seu workspace. Envie exatamente um entre patch, config ou reset; nenhum, ou mais de um, retorna 400. Só um proprietário ou administrador da agência pode fazer essa alteração, e tanto a chave quanto o membro precisam de acesso a todos os clientes: uma chave ou membro limitado a alguns clientes recebe 403, porque esses padrões valem para todos os clientes. Listas de locais não podem ser definidas aqui, já que os locais pertencem a um único cliente; defina-as por cliente. Um 409 significa que as configurações mudaram no mesmo momento: leia-as de novo e tente outra vez. A resposta é igual à do GET e mostra as configurações em vigor.

patch/api/v1/settings/client-notifications
clients:write
Corpo da solicitação
patchobjectopcional
Altera apenas os campos que você informar. Um valor define o campo; null o limpa para voltar ao padrão integrado. Campos omitidos não mudam.
showToClientsbooleanopcional
Se os usuários do portal do cliente veem a página de gerenciar notificações. null volta ao padrão integrado (true).
lockedbooleanopcional
Se a lista de notificações é somente leitura para os clientes. null volta ao padrão integrado (false). Se a página estiver oculta, a lista é sempre salva desbloqueada.
rowsobjectopcional
Alterações por linha de notificação, com o id da linha como chave (approvalRequested, workAssigned, approvalOverdue, commentReplied, workUpdated, reviewsNew, reviewsLow, reviewFetchFinished, reportReady, postPublishFailed, postIdeasReady, clientCredits, connectionReconnect). Cada linha aceita inApp e email, de forma independente. Um id de linha desconhecido retorna 400.
configobjectopcional
Salva a lista inteira de uma vez. Linhas e opções omitidas mantêm os valores atuais. null descarta os padrões salvos do seu workspace e volta aos integrados.
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
Chaves liga/desliga por id de linha, com inApp e email como booleanos. Um id de linha inexistente, ou um valor que não seja booleano, retorna 400.
resetboolean (true)opcional
true descarta os padrões salvos do seu workspace e volta aos integrados.
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
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
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.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
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.
patch/api/v1/settings/client-notifications
Sua chave de API
Corpo da solicitação
{}

Guias que usam este recurso