Synup
Criar chave
v1Recursos/Clients/patchAtualizar as notificações do cliente

Atualizar as notificações do cliente

Consultar configurações efetivas e direitos de edição. Proprietários e administradores podem alterar opções compatíveis preservando valores omitidos. config=null restaura os padrões da agência. Não expõe processos de envio nem configurações internas.

patch/api/v1/clients/{id}/notifications
clients:write
Parâmetros de consulta
idstringobrigatório
Corpo da solicitação
patchobjectopcional
Altera apenas os campos que você indicar, para este cliente ou, com clientUserId, para um dos usuários do portal dele. null limpa um campo para que valha o nível acima: os padrões da agência para um cliente, as configurações do cliente para um usuário do portal. Os campos omitidos continuam como estão.
configobjectopcional
Salva a lista inteira do cliente de uma vez. null descarta as configurações próprias do cliente para que ele volte a seguir os padrões da agência. Não pode ser combinado com clientUserId.
resetboolean (true)opcional
true descarta as configurações salvas, para que o cliente volte a seguir os padrões da agência ou o usuário do portal indicado em clientUserId volte a seguir as configurações do cliente.
clientUserIdstringopcional
Aplica patch ou reset a um usuário ativo do portal deste cliente em vez de ao cliente como um todo.
Resposta
dataobjectobrigatório
configobjectopcional
showToClientsbooleanopcional
lockedbooleanopcional
rowsobjectopcional
customizedbooleanopcional
canManagebooleanopcional
emailReadybooleanopcional
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.
404O recurso não foi encontrado, ou não pertence à sua agência.
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/clients/{id}/notifications
Sua chave de API
id *
Corpo da solicitação
{}

Guias que usam este recurso