Clickfin

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

Atualizar um segmento existente

Atualiza as informações de um segmento de mercado (seja ele principal ou um subsegmento).

Regras para atualização: - Para manter/transformar em um segmento principal: envie isMain: true e não envie parentId. - Para manter/transformar em um subsegmento: envie isMain: false e o parentId de um segmento principal válido. O pai de um subsegmento não pode ser outro subsegmento. - Um segmento principal que ainda possui subsegmentos não pode ser transformado em subsegmento (400).

O segmento e o segmento pai devem pertencer ao licenciado e à empresa selecionada no token. Segmentos de outro licenciado retornam 404. Se a empresa da sessão tiver sido excluída ou deixado de pertencer ao licenciado, retorna 401 MARKET_SEGMENT.UPDATE.NOT_AUTHORIZED.

Requer perfil de Administrador.

AcessoChave de API · market_segments:write
Parâmetros1
Respostas7

Parâmetros

  • segmentIdpath

    ID do segmento a ser atualizado (24 caracteres hexadecimais).

Respostas

200Sucesso

Segmento atualizado com sucesso.

400Erro

Erro de validação ou de regra de hierarquia.

401Erro

Erro de autenticação, ou a empresa da sessão foi excluída/deixou de pertencer ao licenciado no momento da gravação (MARKET_SEGMENT.UPDATE.NOT_AUTHORIZED).

403Erro

Falha de autorização.

404Erro

Segmento ou segmento pai não encontrado, excluído, de outra empresa ou de outro licenciado.

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.