Clickfin

Referência da API
Portal oficial
POST/client

Criar um novo cliente

Cria um novo cliente vinculado à empresa e ao licenciado do usuário autenticado. Todos os campos obrigatórios devem ser fornecidos. marketSegment deve identificar um segmento existente do mesmo licenciado e da empresa autenticada. Segmentos inexistentes, de outra empresa/licenciado ou com ID malformado retornam 404. A empresa é obtida do token; companyId não é aceito no corpo. Se a empresa da sessão tiver sido excluída ou deixado de pertencer ao licenciado, a gravação retorna 401 CLIENT.CREATE.NOT_AUTHORIZED. Requer perfil de Administrador.

AcessoChave de API · clients:write
Parâmetros0
Respostas8

Respostas

201Sucesso

Cliente criado com sucesso.

400Erro

Erro de validação nos dados do cliente (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 de Administrador.

404Erro

Segmento de mercado não encontrado no licenciado e na empresa autenticada, ou 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.