Clickfin

Referência da API
Portal oficial
PUT/client/{clientId}

Atualizar um cliente existente

Atualiza as informações de um cliente específico. O cliente deve pertencer ao licenciado e à empresa selecionada no token; caso contrário, retorna 404. Se a empresa da sessão tiver sido excluída ou deixado de pertencer ao licenciado, a gravação retorna 401 CLIENT.UPDATE.NOT_AUTHORIZED. Qualquer campo enviado no corpo da requisição substituirá o valor existente. Quando enviado, marketSegment deve existir no licenciado autenticado e na empresa já vinculada ao cliente (client.companyId). Essa verificação também ocorre quando o mesmo segmento é reenviado; omitir o campo preserva a referência atual. Segmentos inexistentes, de outra empresa/licenciado ou com ID malformado retornam 404, sem transferir o cliente entre empresas.

AcessoChave de API · clients:write
Parâmetros1
Respostas8

Parâmetros

  • clientIdpath

    ID do cliente a ser atualizado.

Respostas

200Sucesso

Cliente atualizado com sucesso.

400Erro

Erro de validação nos dados enviados (Zod), CPF/CNPJ já em uso, ou empresa não selecionada no token.

401Erro

Erro de autenticação. O token não foi fornecido, é inválido ou expirou.

403Erro

Erro de autorização. O usuário não tem permissão para acessar este recurso.

404Erro

Cliente não encontrado (inclui cliente de outro licenciado ou de outra empresa, antes 403 CLIENT.UPDATE.NOT_AUTHORIZED), ou segmento de mercado não encontrado na empresa do cliente e no licenciado autenticado (inclui ID malformado).

429Erro

Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.

500Erro

Erro interno inesperado.

503Erro

Credencial não pôde ser verificada por falha temporária do servidor (AUTH.SESSION_UNAVAILABLE). Não invalida a chave nem a sessão: repita com backoff.