Clickfin

Referência da API
Portal oficial
DELETE/market-segment/{segmentId}

Excluir um segmento ou subsegmento

Marca o segmento de mercado como excluído e o oculta das listagens e seletores.

Regras para exclusão: - O segmento não pode ter subsegmentos não excluídos associados a ele. - O segmento não pode estar em uso por nenhum cliente não excluído. - O segmento não pode estar em uso por nenhum fornecedor não excluído.

As referências históricas de registros excluídos permanecem íntegras porque o segmento também é preservado.

O segmento 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, retorna 401 MARKET_SEGMENT.DELETE.NOT_AUTHORIZED.

A API não oferece restauração. Requer perfil de Administrador.

AcessoChave de API · market_segments:write
Parâmetros1
Respostas7

Parâmetros

  • segmentIdpath

    ID do segmento a ser excluído (24 caracteres hexadecimais).

Respostas

200Sucesso

Segmento excluído com sucesso.

400Erro

Erro de regra de negócio, não é possível excluir.

401Erro

Token ausente, inválido ou sem empresa selecionada.

403Erro

Falha de autorização.

404Erro

Segmento não encontrado.

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.

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.