A inclusão de endereços de e-mail nas informações cadastrais de clientes que estejam distribuídos para a assessoria pode ser realizada através do método Clientes API - Incluir e-mail.
O identificador (id) do cliente para o qual o e-mail deverá ser incluído deve ser informado na URL de chamada do método.
O parâmetro de entrada email deve ser informado, obrigatoriamente, com o endereço de e-mail a ser incluído nas informações cadastrais do cliente. O parâmetro principal, de preenchimento opcional, pode ser informado para indicar se o novo endereço de e-mail deve (true) ou não (false) passar a ser considerado como o endereço de e-mail principal do cliente; se não for informado este parâmetro, o novo endereço de e-mail não será incluído como sendo o endereço de e-mail principal do cliente.
O método retorna, no atributo id, o identificador interno gerado para o novo endereço de e-mail; no atributo idExterno, retorna o identificador externo gerado, quando for o caso, para o novo endereço de e-mail; e, no atributo usuarioCriador, retorna as informações (id e nome) do usuário responsável pela inclusão do e-mail, além das informações do próprio endereço de e-mail incluído, conforme descrito na documentação do método.
Se a assessoria não possuir permissão para alterar informações cadastrais de clientes, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "Você não tem permissão para alterar informações cadastrais".
Se o cliente para o qual a assessoria estiver tentando alterar informações cadastrais não estiver distribuído para a assessoria, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "Você não tem permissão para visualizar esse cliente".
Exemplos de chamadas e de retornos deste método constam no arquivo Assessorias - Clientes API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.
0 Comentários