A inclusão de telefones nas informações cadastrais de clientes que estejam distribuídos para a assessoria pode ser realizada através do método Clientes API - Incluir telefone.
O identificador (id) do cliente para o qual o telefone deverá ser incluído deve ser informado na URL de chamada do método.
O parâmetro de entrada ddd deve ser informado, obrigatoriamente, com o código DDD do telefone a ser incluído nas informações cadastrais do cliente. O parâmetro de entrada telefone deve ser informado, obrigatoriamente, com o número do telefone. O parâmetro ramal, de preenchimento opcional, pode ser informado com o número do ramal. O parâmetro de entrada tipo (CELULAR, RESIDENCIAL, COMERCIAL, RECADO, FAX e OUTRO) deve ser informado, obrigatoriamente, com um dos tipos de telefone disponíveis. O parâmetro principal, de preenchimento opcional, pode ser informado para indicar se o novo telefone deve (true) ou não (false) passar a ser considerado como o telefone principal do cliente; se não for informado este parâmetro, o novo telefone não será incluído como sendo o telefone principal do cliente.
O método retorna, no atributo id, o identificador interno gerado para o novo telefone; no atributo idExterno, retorna o identificador externo gerado, quando for o caso, para o novo telefone; e, no atributo usuarioCriador, retorna as informações (id e nome) do usuário responsável pela inclusão do telefone, além das informações do próprio telefone 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